Skip to content

Commit 32bff0b

Browse files
carsten-walthercarsten-walther
committed
add some documentation
1 parent c932786 commit 32bff0b

File tree

15 files changed

+424
-6
lines changed

15 files changed

+424
-6
lines changed

‎Documentation/ChangeLog/Index.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../Includes.txt
7+
8+
.. _changelog:
9+
10+
ChangeLog
11+
=========
12+
13+
See https://github.com/carsten-walther/image_copyright

‎Documentation/Configuration/Index.rst

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../Includes.txt
7+
8+
.. _configuration:
9+
10+
Configuration
11+
=============
12+
13+
Target group: **Developers, Integrators**
14+
15+
You can set global copyright informations by typoscript.
16+
17+
To get all images of your page, you hafe to set the table field configuration and/or the table field configuration for collections.
18+
19+
Typical Configuration
20+
---------------------
21+
22+
Example of TypoScript Configuration (Constants):
23+
24+
.. code-block:: typoscript
25+
26+
plugin.tx_imagecopyright {
27+
settings {
28+
extensions = jpg, jpeg, png, gif
29+
showEmpty = 1
30+
includeFileCollections = 1
31+
globalCopyright = Example Company
32+
}
33+
}
34+
35+
Example of TypoScript Configuration (Setup):
36+
37+
.. code-block:: typoscript
38+
39+
plugin.tx_imagecopyright {
40+
settings {
41+
tableFieldConfiguration {
42+
10 {
43+
extension = core
44+
tableName = pages
45+
}
46+
20 {
47+
extension = core
48+
tableName = tt_content
49+
}
50+
30 {
51+
extension = news
52+
tableName = tx_news_domain_model_news
53+
}
54+
}
55+
tableFieldConfigurationForCollections {
56+
10 {
57+
extension = core
58+
tableName = tt_content
59+
fieldName = file_collections
60+
}
61+
}
62+
}
63+
}
64+
65+
.. _configuration-typoscript:

‎Documentation/Developer/Index.rst

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../Includes.txt
7+
8+
.. _developer:
9+
10+
Developer Corner
11+
================
12+
13+
Target group: **Developers**
14+
15+
...

‎Documentation/Images/UserManual/plugin.png

180 KB
Loading

‎Documentation/Includes.txt

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. This is 'Includes.txt'. It is included at the very top of each and
2+
every ReST source file in THIS documentation project (= manual).
3+
4+
.. This files lives at
5+
https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/blob/master/Documentation/Includes.txt
6+
Version: 2018-10-16
7+
8+
.. More information about this file:
9+
https://docs.typo3.org/typo3cms/HowToDocument/GeneralConventions/DirectoryFilenames.html#includes-txt
10+
11+
.. Define some additional textroles
12+
See: https://docs.typo3.org/typo3cms/HowToDocument/WritingReST/InlineCode.html
13+
14+
15+
.. ---------
16+
.. textroles
17+
.. ---------
18+
19+
.. role:: aspect (emphasis)
20+
.. role:: html(code)
21+
.. role:: js(code)
22+
.. role:: php(code)
23+
.. role:: rst(code)
24+
.. role:: sep (strong)
25+
.. role:: typoscript(code)
26+
27+
.. role:: ts(typoscript)
28+
:class: typoscript
29+
30+
.. role:: yaml(code)
31+
32+
.. default-role:: code
33+
34+
.. ---------
35+
.. highlight
36+
.. ---------
37+
38+
.. By default, code blocks are php
39+
40+
.. highlight:: php

‎Documentation/Index.rst

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: Includes.txt
7+
8+
.. _start:
9+
10+
=============================================================
11+
Html2PDF
12+
=============================================================
13+
14+
:Extension Key:
15+
image_copyright
16+
17+
:Version:
18+
|release|
19+
20+
:Language:
21+
en
22+
23+
:Copyright:
24+
2020
25+
26+
:Author:
27+
Carsten Walther
28+
29+
:Email:
30+
walther.carsten@web.de
31+
32+
:License:
33+
This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml
34+
35+
:Rendered:
36+
|today|
37+
38+
**TYPO3**
39+
40+
The content of this document is related to TYPO3 CMS, a GNU/GPL CMS/Framework available from `typo3.org <https://typo3.org/>`_ .
41+
42+
**Community Documentation:**
43+
44+
This documentation is community documentation for the TYPO3 extension html2pdf Extension
45+
46+
It is maintained as part of this third party extension.
47+
48+
If you find an error or something is missing, please:
49+
`Report a Problem <https://github.com/carsten-walther/image_copyright/issues/new>`__
50+
51+
**Sitemap:**
52+
53+
:ref:`sitemap`
54+
55+
.. toctree::
56+
:maxdepth: 5
57+
:titlesonly:
58+
:glob:
59+
60+
Introduction/Index
61+
UsersManual/Index
62+
Installation/Index
63+
Configuration/Index
64+
Developer/Index
65+
KnownProblems/Index
66+
ToDoList/Index
67+
ChangeLog/Index
68+
Sitemap

‎Documentation/Installation/Index.rst

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../Includes.txt
7+
8+
.. _installation:
9+
10+
Installation
11+
============
12+
13+
Target group: **Administrators**
14+
15+
.. important::
16+
17+
This extension is made for TYPO3 CMS 10.x LTS.
18+
19+
The extension needs to be installed as any other extension of TYPO3 CMS:
20+
21+
Latest version from git
22+
-----------------------
23+
You can get the latest version from git by using the git command:
24+
25+
.. code-block:: bash
26+
27+
git clone git@github.com:carsten-walther/image_copyright.git
28+
29+
.. important::
30+
31+
The master branch supports latest TYPO3 CMS only.
32+
33+
Preparation: Include static TypoScript
34+
--------------------------------------
35+
36+
You have to include the TypoScript statics to use this extension.

‎Documentation/Introduction/Index.rst

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../Includes.txt
7+
8+
.. _introduction:
9+
10+
Introduction
11+
============
12+
13+
This chapter gives you a basic introduction about the TYPO3 CMS extension “image_copyright”.
14+
15+
.. _what-it-does:
16+
17+
What does it do?
18+
----------------
19+
20+
Add copyright informations of all images to your site.
21+
This extension will add copyright information plugins to your TYPO3 website.
22+
23+
Screenshots
24+
-----------
25+
26+
.. figure:: ../Images/UserManual/plugin.png
27+
:class: with-shadow
28+
:alt: Plugin
29+
:width: 300px
30+
31+
Plugin

‎Documentation/KnownProblems/Index.rst

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../Includes.txt
7+
8+
.. _known-problems:
9+
10+
Known Problems
11+
==============
12+
13+
The following issues are known problems.
14+
15+
Here is currently nothing.

‎Documentation/Settings.cfg

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# coding: utf-8
2+
3+
# #####
4+
#
5+
# Settings.cfg - A TYPO3 Documentation Project's Configuration File
6+
# Information about Settings.cfg:
7+
# https://docs.typo3.org/typo3cms/HowToDocument/GeneralConventions/DirectoryFilenames.html#settings-cfg
8+
#
9+
# About Syntax:
10+
# See https://docs.python.org/2/library/configparser.html
11+
#
12+
# Attention:
13+
# Only " ;" can start an inline comment.
14+
# This is: blank PLUS semicolon!
15+
#
16+
# #####
17+
18+
[general]
19+
20+
# .................................................................................
21+
# ... (required) title (displayed in left sidebar (desktop) or top panel (mobile)
22+
# .................................................................................
23+
24+
project = Image Copyright
25+
26+
# .................................................................................
27+
# ... (recommended) version, displayed next to title (desktop) and in <meta name="book-version"
28+
# .................................................................................
29+
30+
release = 1.0.2
31+
32+
# .................................................................................
33+
# ... (recommended) displayed in footer
34+
# .................................................................................
35+
36+
copyright = Carsten Walther
37+
38+
[html_theme_options]
39+
40+
# .................................................................................
41+
# ... (recommended) to get the "Edit me on Github Button"
42+
# .................................................................................
43+
44+
github_branch = master
45+
github_repository = carsten-walther/image_copyright
46+
47+
# .................................................................................
48+
# ... (recommended) Fill in values to get links in the "Related Links" section
49+
# .................................................................................
50+
51+
# usually an email address
52+
project_contact = walther.carsten@web.de
53+
54+
# URL of online discussions, you can leave this blank
55+
project_discussions =
56+
57+
# URL of webpage of your extension (if it has one)
58+
project_home = https://github.com/carsten-walther/image_copyright
59+
60+
# URL to Issues
61+
project_issues = https://github.com/carsten-walther/image_copyright/issues
62+
63+
# URL of repository
64+
project_repository = https://github.com/carsten-walther/image_copyright
65+
66+
[intersphinx_mapping]
67+
68+
# .................................................................................
69+
# for cross-referencing across manuals (intersphinx) with :ref:
70+
#
71+
# You must uncomment all manuals you use in your cross-references
72+
#
73+
# Example usage:
74+
# :ref:`t3contribute:start` will link to start page of Contribution Guide
75+
# .................................................................................
76+
77+
h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/
78+
# t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/
79+
# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/master/en-us/
80+
# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/Index.html
81+
# t3install = https://docs.typo3.org/m/typo3/guide-installation/master/en-us/
82+
# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/master/en-us/
83+
# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/master/en-us/
84+
# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/master/en-us/
85+
# t3tca = https://docs.typo3.org/m/typo3/reference-tca/master/en-us/
86+
# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating-with-fluid/master/en-us/
87+
# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/master/en-us/
88+
# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/master/en-us/
89+
t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/
90+
91+
[extensions]
92+
93+
# This is required for embedding YouTube videos
94+
95+
any_name_youtube = sphinxcontrib.youtube

‎Documentation/Sitemap.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
:template: sitemap.html
2+
3+
.. _sitemap:
4+
5+
Sitemap
6+
=======

0 commit comments

Comments
 (0)