[TASK] Improve form documentation 98/56998/2
authorBjörn Jacob <bjoern.jacob@tritum.de>
Thu, 17 May 2018 15:27:55 +0000 (17:27 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Fri, 18 May 2018 08:28:05 +0000 (10:28 +0200)
* introduce new role for inline YAML code styles
* fix some internal and external links

Resolves: #85037
Releases: master, 8.7
Change-Id: Ie5581bcc911914c49511ff86c5679f04c45c9f00
Reviewed-on: https://review.typo3.org/56998
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/form/Documentation/Config/proto/formElements/formElementTypes/Form/renderingOptions/honeypot/enable.rst
typo3/sysext/form/Documentation/FAQ/Index.rst
typo3/sysext/form/Documentation/Includes.txt

index e4c85fb..4afa31e 100644 (file)
@@ -87,5 +87,5 @@ renderingOptions.honeypot.enable
                       honeypot:
                         enable: false
 
-   See forge issue `#83212 <https://forge.typo3.org/issues/83212>` for more
+   See forge issue `#83212 <https://forge.typo3.org/issues/83212>`_ for more
    information.
\ No newline at end of file
index 8448db2..917d015 100644 (file)
@@ -121,7 +121,7 @@ How do I localize the client side validations in the frontend?
 The displayed validation message is a browser specific text. The output is
 not generated by TYPO3 and therefore you cannot change it easily.
 Nevertheless, there is a JavaScript solution for changing the validation
-message. See `Stack Overflow <http://stackoverflow.com/questions/5272433/html5-form-required-attribute-set-custom-validation-message>`
+message. See `Stack Overflow <http://stackoverflow.com/questions/5272433/html5-form-required-attribute-set-custom-validation-message>`_
 for more information.
 
 
@@ -160,7 +160,7 @@ The honeypot does not work with static site caching. What can I do?
 
 If you want to use a static site caching - for example using the
 staticfilecache extension - you should disable the automatic inclusion of the
-honeypot. Read more ':ref:`here<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.honeypot.enable>`'.
+honeypot. Read more :ref:`here<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.honeypot.enable>`.
 
 
 .. _faq-form-element-default-value:
@@ -180,5 +180,5 @@ form is loaded. In contrast, the :yaml:`prependOptionValue` allows you to define
 string which will be shown as the first select-option. If both settings exist,
 the :yaml:`defaultValue` is prioritized.
 
-Learn more ':ref:`here<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.defaultValue>`'
-and see the forge issue `#82422 <https://forge.typo3.org/issues/82422#note-6>`.
\ No newline at end of file
+Learn more :ref:`here<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.defaultValue>`
+and see the forge issue `#82422 <https://forge.typo3.org/issues/82422#note-6>`_.
\ No newline at end of file
index aec1bed..ddee8c1 100644 (file)
@@ -5,9 +5,15 @@
 .. role:: html(code)
 .. role:: js(code)
 .. role:: php(code)
+.. role:: sep (strong)
 .. role:: typoscript(code)
+
 .. role:: ts(typoscript)
    :class: typoscript
 
-.. highlight:: php
 .. default-role:: code
+.. highlight:: php
+
+.. special in this manual:
+
+.. role:: yaml(code)