[TASK] Documentation

typo3-themes · Dec 13, 2014 · d0fe53d · d0fe53d
1 parent 07715f1
commit d0fe53d
Show file tree

Hide file tree

Showing 29 changed files with 107 additions and 32 deletions.
diff --git a/Documentation/Include/TypoScript/Constants.rst b/Documentation/Include/TypoScript/Constants.rst
diff --git a/Documentation/Include/TypoScript/Constants/Theme.rst b/Documentation/Include/TypoScript/Constants/Theme.rst
diff --git a/Documentation/Include/TypoScript/Setup.rst b/Documentation/Include/TypoScript/Setup.rst
diff --git a/Documentation/Include/TypoScript/Setup/Content.rst b/Documentation/Include/TypoScript/Setup/Content.rst
diff --git a/Documentation/Include/TypoScript/Setup/Page.rst b/Documentation/Include/TypoScript/Setup/Page.rst
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -0,0 +1,19 @@
+..  Editor configuration
+    ...................................................
+    * utf-8 with BOM as encoding
+    * tab indent with 4 characters for code snippet.
+    * optional: soft carriage return preferred.
+
+.. Includes roles, substitutions, ...
+.. include:: ./_IncludedDirectives.rst
+
+=================================
+Themes-GridElements Documentation
+=================================
+
+**Table of content**
+
+.. toctree::
+    :maxdepth: 4
+
+    TypoScript/Index
diff --git a/...onstants/Themes/Configuration/Baseurl.rst → ...cript/Constants/Configuration/Baseurl.rst b/...onstants/Themes/Configuration/Baseurl.rst → ...cript/Constants/Configuration/Baseurl.rst
@@ -1,3 +1,6 @@
+themes.configuration.baseurl
+----------------------------
+
 .. ..................................
 .. container:: table-row dl-horizontal panel panel-default constants themes_gridelements cat_theme
 

diff --git a/...ants/Themes/Configuration/BaseurlIcon.rst → ...t/Constants/Configuration/BaseurlIcon.rst b/...ants/Themes/Configuration/BaseurlIcon.rst → ...t/Constants/Configuration/BaseurlIcon.rst
@@ -1,3 +1,6 @@
+themes.configuration.baseurlIcon
+--------------------------------
+
 .. ..................................
 .. container:: table-row dl-horizontal panel panel-default constants themes_gridelements cat_theme
 
@@ -21,4 +24,4 @@
 
 	Definition
 		# cat=theme; type=string; label= Icon base URL of the site (http://cdn.domain.tdl/project/Icons/; http://www.domain.tld/fileadmin/project/Icons/)
-		themes.configuration.baseurlImage = http://demo.typo3-themes.org/typo3conf/ext/theme_bootstrap/Resources/Public/Icons/
+		themes.configuration.baseurlIcon = http://demo.typo3-themes.org/typo3conf/ext/theme_bootstrap/Resources/Public/Icons/
diff --git a/...nts/Themes/Configuration/BaseurlImage.rst → .../Constants/Configuration/BaseurlImage.rst b/...nts/Themes/Configuration/BaseurlImage.rst → .../Constants/Configuration/BaseurlImage.rst
@@ -1,3 +1,6 @@
+themes.configuration.baseurlImage
+---------------------------------
+
 .. ..................................
 .. container:: table-row dl-horizontal panel panel-default constants themes_gridelements cat_theme
 

diff --git a/...onstants/Themes/Configuration/Favicon.rst → ...cript/Constants/Configuration/Favicon.rst b/...onstants/Themes/Configuration/Favicon.rst → ...cript/Constants/Configuration/Favicon.rst
@@ -1,3 +1,6 @@
+themes.configuration.favicon
+----------------------------
+
 .. ..................................
 .. container:: table-row dl-horizontal panel panel-default constants themes_gridelements cat_theme
 

diff --git a/...nstants/Themes/Configuration/SiteName.rst → ...ript/Constants/Configuration/SiteName.rst b/...nstants/Themes/Configuration/SiteName.rst → ...ript/Constants/Configuration/SiteName.rst
@@ -1,3 +1,6 @@
+themes.configuration.siteName
+-----------------------------
+
 .. ..................................
 .. container:: table-row dl-horizontal panel panel-default constants themes_gridelements cat_theme
 

diff --git a/...tants/Themes/Configuration/SiteSlogan.rst → ...pt/Constants/Configuration/SiteSlogan.rst b/...tants/Themes/Configuration/SiteSlogan.rst → ...pt/Constants/Configuration/SiteSlogan.rst
@@ -1,3 +1,6 @@
+themes.configuration.siteSlogan
+-------------------------------
+
 .. ..................................
 .. container:: table-row dl-horizontal panel panel-default constants themes_gridelements cat_theme
 

diff --git a/...ion/SpamProtectEmailAddresses/AtSubst.rst → ...ion/SpamProtectEmailAddresses/AtSubst.rst b/...ion/SpamProtectEmailAddresses/AtSubst.rst → ...ion/SpamProtectEmailAddresses/AtSubst.rst
@@ -1,3 +1,6 @@
+themes.configuration.spamProtectEmailAddresses.atSubst
+------------------------------------------------------
+
 .. ..................................
 .. container:: table-row dl-horizontal panel panel-default constants themes_gridelements cat_theme
 

diff --git a/...pamProtectEmailAddresses/LastDotSubst.rst → ...pamProtectEmailAddresses/LastDotSubst.rst b/...pamProtectEmailAddresses/LastDotSubst.rst → ...pamProtectEmailAddresses/LastDotSubst.rst
@@ -1,3 +1,6 @@
+themes.configuration.spamProtectEmailAddresses.lastDotSubst
+-----------------------------------------------------------
+
 .. ..................................
 .. container:: table-row dl-horizontal panel panel-default constants themes_gridelements cat_theme
 

diff --git a/Documentation/TypoScript/Constants/Index.rst b/Documentation/TypoScript/Constants/Index.rst
@@ -0,0 +1,14 @@
+.. include:: ../../_IncludedDirectives.rst
+
+====================
+TypoScript-Constants
+====================
+
+**Table of content**
+
+.. toctree::
+	:maxdepth: 5
+	:glob:
+
+	Configuration/*
+	Configuration/SpamProtectEmailAddresses/*
diff --git a/Documentation/TypoScript/Index.rst b/Documentation/TypoScript/Index.rst
@@ -0,0 +1,13 @@
+.. include:: ../_IncludedDirectives.rst
+
+==========
+TypoScript
+==========
+
+**Table of content**
+
+.. toctree::
+	:maxdepth: 4
+
+	Constants/Index
+	Setup/Index
diff --git a/Documentation/TypoScript/Setup/Index.rst b/Documentation/TypoScript/Setup/Index.rst
@@ -0,0 +1,14 @@
+.. include:: ../../_IncludedDirectives.rst
+
+================
+TypoScript-Setup
+================
+
+**Table of content**
+
+.. toctree::
+	:maxdepth: 5
+	:glob:
+
+	Lib/Content/*
+	Lib/Page/*
diff --git a/...TypoScript/Setup/Lib/Content/Extended.rst → ...TypoScript/Setup/Lib/Content/Extended.rst b/...TypoScript/Setup/Lib/Content/Extended.rst → ...TypoScript/Setup/Lib/Content/Extended.rst
diff --git a/.../TypoScript/Setup/Lib/Content/Feature.rst → .../TypoScript/Setup/Lib/Content/Feature.rst b/.../TypoScript/Setup/Lib/Content/Feature.rst → .../TypoScript/Setup/Lib/Content/Feature.rst
diff --git a/...ude/TypoScript/Setup/Lib/Content/Main.rst → ...ion/TypoScript/Setup/Lib/Content/Main.rst b/...ude/TypoScript/Setup/Lib/Content/Main.rst → ...ion/TypoScript/Setup/Lib/Content/Main.rst
diff --git a/...ude/TypoScript/Setup/Lib/Content/Menu.rst → ...ion/TypoScript/Setup/Lib/Content/Menu.rst b/...ude/TypoScript/Setup/Lib/Content/Menu.rst → ...ion/TypoScript/Setup/Lib/Content/Menu.rst
diff --git a/.../TypoScript/Setup/Lib/Content/Sidebar.rst → .../TypoScript/Setup/Lib/Content/Sidebar.rst b/.../TypoScript/Setup/Lib/Content/Sidebar.rst → .../TypoScript/Setup/Lib/Content/Sidebar.rst
diff --git a/...lude/TypoScript/Setup/Lib/Page/Author.rst → ...tion/TypoScript/Setup/Lib/Page/Author.rst b/...lude/TypoScript/Setup/Lib/Page/Author.rst → ...tion/TypoScript/Setup/Lib/Page/Author.rst
diff --git a/...TypoScript/Setup/Lib/Page/AuthorEmail.rst → ...TypoScript/Setup/Lib/Page/AuthorEmail.rst b/...TypoScript/Setup/Lib/Page/AuthorEmail.rst → ...TypoScript/Setup/Lib/Page/AuthorEmail.rst
diff --git a/.../TypoScript/Setup/Lib/Page/LastUpdate.rst → .../TypoScript/Setup/Lib/Page/LastUpdate.rst b/.../TypoScript/Setup/Lib/Page/LastUpdate.rst → .../TypoScript/Setup/Lib/Page/LastUpdate.rst
diff --git a/...de/TypoScript/Setup/Lib/Page/NavTitle.rst → ...on/TypoScript/Setup/Lib/Page/NavTitle.rst b/...de/TypoScript/Setup/Lib/Page/NavTitle.rst → ...on/TypoScript/Setup/Lib/Page/NavTitle.rst
diff --git a/...de/TypoScript/Setup/Lib/Page/SubTitle.rst → ...on/TypoScript/Setup/Lib/Page/SubTitle.rst b/...de/TypoScript/Setup/Lib/Page/SubTitle.rst → ...on/TypoScript/Setup/Lib/Page/SubTitle.rst
diff --git a/...clude/TypoScript/Setup/Lib/Page/Title.rst → ...ation/TypoScript/Setup/Lib/Page/Title.rst b/...clude/TypoScript/Setup/Lib/Page/Title.rst → ...ation/TypoScript/Setup/Lib/Page/Title.rst
diff --git a/Documentation/_IncludedDirectives.rst b/Documentation/_IncludedDirectives.rst
@@ -0,0 +1,22 @@
+..  Content substitution
+    ...................................................
+    Hint: following expression |my_substition_value| will be replaced when rendering doc.
+
+.. |author| replace:: Jo Hasenau <info@cybercraft.de>, Kay Strobach <typo3themes@kay-strobach.de>, Thomas Deuling <typo3@coding.ms>
+.. |extension_key| replace:: themes_gridelements
+.. |extension_name| replace:: Themes-GridElements
+.. |version| replace:: 0.1.0
+.. |version_typo3| replace:: TYPO3 6.2.x
+.. |time| date:: %Y-%m-%d %H:%M
+
+..  Custom roles
+    ...................................................
+    After declaring a role like this: ".. role:: custom", the document may use the new role like :custom:`interpreted text`. 
+    Basically, this will wrap the content with a CSS class to be styled in a special way when document get rendered.
+    More information: http://docutils.sourceforge.net/docs/ref/rst/roles.html
+
+.. role:: code
+.. role:: typoscript
+.. role:: typoscript(code)
+.. role:: ts(typoscript)
+.. role:: php(code)