[BUGFIX] Lots of reST syntax errors

Documentation/Fluid/Index.rst

@@ -4,17 +4,16 @@ Fluid Guide
 ===========
 
 This Guide demonstrates the usage of Fluid to render output.
-Fluid is a template engine that is designed to be flexible and extensible, but easy to use. It is part of TYPO3 FLOW and 
+Fluid is a template engine that is designed to be flexible and extensible, but easy to use. It is part of TYPO3 FLOW and
 TYPO3 CMS.
 
 
 **Table of Contents**
 
 .. toctree::
-   :maxdepth: 5
-   :titlesonly:
-   :glob:
 
    ViewHelper/Index
+   UniversalTagAttributes
+   UniversalFormFieldAttributes
    ThingsToKnow/Index
    BestPractice/Index

Documentation/Fluid/UniversalFormFieldAttributes.txt → Documentation/Fluid/UniversalFormFieldAttributes.rst

@@ -1,45 +1,49 @@
+
+
+.. _UniversalFormFieldAttributes:
+
+Universal Form Field Attributes
+===============================
+
 Global properties for form elements
-###################################
+
 
 name
-~~~~
+----
+
 :aspect:`Variable type`
-    String
+   String
 
 :aspect:`Description`
-    The name of the form element
+   The name of the form element
 
-:aspect:`Default value`
-
 
 :aspect:`Mandatory`
-    No
+   No
 
 value
-~~~~~
+-----
+
 :aspect:`Variable type`
-    String
+   String
 
 :aspect:`Description`
-    The value which should be send when transmitting the form.
+   The value which should be send when transmitting the form.
+
 
-:aspect:`Default value`
-
-
 :aspect:`Mandatory`
     No
 
 property
-~~~~~~~~
+--------
+
 :aspect:`Variable type`
     String
 
 :aspect:`Description`
-    As an alternative to working with a field name and field value, the field can be provided with a property in the 
+    As an alternative to working with a field name and field value, the field can be provided with a property in the
     format of an `f:form` object. The “name� and �value� properties are then set automatically.
 
-:aspect:`Default value`
-
-
+
 :aspect:`Mandatory`
     No

Documentation/Fluid/UniversalTagAttributes.txt → Documentation/Fluid/UniversalTagAttributes.rst

@@ -3,10 +3,11 @@
 
 
 Global properties of the HTML element
-#####################################
+=====================================
 
 class
-~~~~~
+-----
+
 :aspect:`Variable type`
     String
 
@@ -20,7 +21,8 @@ class
     No
 
 dir
-~~~
+---
+
 :aspect:`Variable type`
     String
 
@@ -34,7 +36,8 @@ dir
     No
 
 id
-~~
+--
+
 :aspect:`Variable type`
     String
 
@@ -48,7 +51,8 @@ id
     No
 
 lang
-~~~~
+----
+
 :aspect:`Variable type`
     String
 
@@ -62,7 +66,8 @@ lang
     No
 
 style
-~~~~~
+-----
+
 :aspect:`Variable type`
     String
 
@@ -75,8 +80,10 @@ style
 :aspect:`Mandatory`
     No
 
+
 title
-~~~~~
+-----
+
 :aspect:`Variable type`
     String
 
@@ -90,7 +97,8 @@ title
     No
 
 accesskey
-~~~~~~~~~
+---------
+
 :aspect:`Variable type`
     String
 
@@ -104,7 +112,8 @@ accesskey
     No
 
 tabindex
-~~~~~~~~
+--------
+
 :aspect:`Variable type`
     Integer
 
@@ -118,7 +127,8 @@ tabindex
     No
 
 onclick
-~~~~~~~
+-------
+
 :aspect:`Variable type`
     String
 
@@ -132,7 +142,8 @@ onclick
     No
 
 data
-~~~~
+----
+
 :aspect:`Variable type`
     Array
 

Documentation/Fluid/ViewHelper/Be/Buttons/Csh.rst

@@ -5,8 +5,8 @@ f:be.buttons.csh
 
 This ViewHelper is rarely used, but very helpful nonetheless. It enables you to include hints into backend forms.
 
-TYPO3 uses this functionality all over the backend, and it is noticeable by the small “question mark” images. Hovering 
-over the element reveals help text in a small tooltip, whilst clicking on the element displays the help text in a popup 
+TYPO3 uses this functionality all over the backend, and it is noticeable by the small “question mark” images. Hovering
+over the element reveals help text in a small tooltip, whilst clicking on the element displays the help text in a popup
 window. A user configuration setting is available, to allow or disallow the popup window.
 
 Properties
@@ -15,44 +15,46 @@ Properties
 table
 ~~~~~
 :aspect:`Variable type`
-    String
+   String
 
 :aspect:`Description`
-    Database table name.
+   Database table name.
 
 :aspect:`Default value`
-    NULL
+   NULL
 
 :aspect:`Required`
-    No
+   No
+
 
 field
 ~~~~~
 :aspect:`Variable type`
-    String
+   String
 
 :aspect:`Description`
-    The key from the locallang file.
+   The key from the locallang file.
 
 :aspect:`Default value`
-    Empty string
+   Empty string
 
 :aspect:`Required`
-    No
+   No
 
 iconOnly
 ~~~~~~~~
 :aspect:`Variable type`
-    Boolean
+   Boolean
 
 :aspect:`Description`
-    Display the icon, but not the text.
+   Display the icon, but not the text.
 
 :aspect:`Default value`
-    FALSE
+   FALSE
 
 :aspect:`Required`
-    No
+   No
+
 
 styleAttributes
 ~~~~~~~~~~~~~~~
@@ -72,78 +74,90 @@ styleAttributes
 Special case
 ------------
 
-There's a special case in which the “table” property doesn't need to be defined. This is the case then there are 
-form fields in the module, but when there is no 1:1 column in the database. For example, in the Scheduler, which 
-stores its information in a serialized format in a single field, or in the case of a search field, whose value isn't 
-sent to the database. Such fields can be assigned a csh icon through the addition of an entry in ext_tables.php.::
+There's a special case in which the “table” property doesn't need to be defined. This is the case then there are
+form fields in the module, but when there is no 1:1 column in the database. For example, in the Scheduler, which
+stores its information in a serialized format in a single field, or in the case of a search field, whose value isn't
+sent to the database. Such fields can be assigned a csh icon through the addition of an entry in
+:file:`ext_tables.php`::
 
- \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr(
-   '_MOD_FullModuleName',
-   'Path to a language file'
- );
+   \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr(
+      '_MOD_FullModuleName',
+      'Path to a language file'
+   );
 
 
-Note the reference to the fully-formed module name. This is comprised of the category (e.g. “web”), the 
-upper-camel-cased extension name and the upper-camel-cased module name. In the example of an extension named 
+Note the reference to the fully-formed module name. This is comprised of the category (e.g. “web”), the
+upper-camel-cased extension name and the upper-camel-cased module name. In the example of an extension named
 “sfextbase” and a module named “extbase”, the complete name would be::
 
- web_SfextbaseExtbase
+   web_SfextbaseExtbase
 
 
 Here's an example of how the configuration might appear::
 
- \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr(
-   '_MOD_web_SfextbaseExtbase',
-   'EXT:' . $_EXTKEY . '/Resources/Private/Language/locallang_extbase.xlf'
- );
+   \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr(
+      '_MOD_web_SfextbaseExtbase',
+      'EXT:' . $_EXTKEY . '/Resources/Private/Language/locallang_extbase.xlf'
+   );
+
 
+The entry for the email address in the XLF file would be as follows:
 
-The entry for the email address in the XLF file would be as follows::
+.. code-block:: xml
 
- <trans-unit id="email.alttitle" xml:space="preserve">
-   <source>Email</source>
- </trans-unit>
- <trans-unit id="email.description" xml:space="preserve">
-   <source>Enter your email address</source>
- </trans-unit>
- <trans-unit id="email.details" xml:space="preserve">
-   <source>I am a really long description, which gives plenty of detail about this field relating to an email address, 
-   as well as what you need to note and that you need to add a valid email address in this field.</source>
- </trans-unit>
+    <trans-unit id="email.alttitle" xml:space="preserve">
+      <source>Email</source>
+    </trans-unit>
+    <trans-unit id="email.description" xml:space="preserve">
+      <source>Enter your email address</source>
+    </trans-unit>
+    <trans-unit id="email.details" xml:space="preserve">
+      <source>
+         I am a really long description, which gives plenty of detail about this field relating to an email address,
+         as well as what you need to note and that you need to add a valid email address in this field.
+      </source>
+    </trans-unit>
 
 
 Examples
 --------
 
-.. caution::
+.. attention::
+
+   There is a request to the backend user option `edit_showFieldHelp` within the source code of the csh API.
+   This isn't set by default, which therefore blocks the output of the csh help text. In order to see a
+   working version of this ViewHelper, you'll need to ensure that the following option is set within the
+   TS config for the active user or user group:
 
- There is a request to the backend user option edit_showFieldHelp within the source code of the csh API. This isn't 
- set by default, which therefore blocks the output of the csh help text. In order to see a working version of this 
- ViewHelper, you'll need to ensure that the following option is set within the TS config for the active user or user 
- group.::
+   .. code-block:: typoscript
 
-  setup.override.edit_showFieldHelp = text
+      setup.override.edit_showFieldHelp = text
 
 
 Example: database fields
-########################
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-In the majority of TYPO3 tables, the language file key is usually the same as the column name::
+In the majority of TYPO3 tables, the language file key is usually the same as the column name:
 
- <f:be.buttons.csh table="tt_content" field="header" />
+.. code-block:: html
+
+   <f:be.buttons.csh table="tt_content" field="header" />
 
 
 Example: style attributes
-#########################
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
-::
+.. code-block:: html
 
- <f:be.buttons.csh table="tt_content" field="header" styleAttributes="background-color: red;" />
+   <f:be.buttons.csh table="tt_content" field="header" styleAttributes="background-color: red;" />
 
 
 Example: Icons for form fields without a 1:1 database structure
-###############################################################
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This example relates to the special case mentioned above, in which the table name may not be indicated:
+
+.. code-block:: html
 
-This example relates to the special case mentioned above, in which the table name may not be indicated.::
+   <f:be.buttons.csh field="email" />
 
- <f:be.buttons.csh field="email" />