plugin.tx_restdoc_pi1¶
Properties¶
Property | Data type | t3tsref:stdwrap | Default |
---|---|---|---|
path | t3tsref:data-type-string | yes | empty |
defaultFile | t3tsref:data-type-string | yes | “index” |
mode | t3tsref:data-type-string | yes | empty |
rootPage | t3tsref:data-type-integer | yes | empty |
showPermanentLink | t3tsref:data-type-boolean | yes | 0 |
pathSeparator | t3tsref:data-type-string | yes | “|” (vertical bar) |
fallbackPathSeparator | t3tsref:data-type-string | yes | “" (backslash) |
documentStructureMaxDocuments | t3tsref:data-type-integer | yes | 50 |
advertiseSphinx | t3tsref:data-type-boolean | yes | 1 |
addHeadPagination | t3tsref:data-type-boolean | yes | 1 |
publishSources | t3tsref:data-type-boolean | yes | 1 |
baseWrap | t3tsref:stdwrap | yes | empty |
Property details¶
path¶
plugin.tx_restdoc_pi1.path =
t3tsref:data-type-string
Path to the root directory of the documentation.
mode¶
plugin.tx_restdoc_pi1.mode =
t3tsref:data-type-string
Either BODY
, TOC
, RECENT
, TITLE
, QUICK_NAVIGATION
, BREADCRUMB
, REFERENCES
, FILENAME
or SEARCH
to setup the plugin from TypoScript.
rootPage¶
plugin.tx_restdoc_pi1.rootPage =
t3tsref:data-type-integer
UID of the page showing the documentation. This setting is used when mode = SEARCH
to link back to the
documentation from search results.
showPermanentLink¶
plugin.tx_restdoc_pi1.showPermanentLink =
t3tsref:data-type-boolean
Whether permanent links should be added to each section.
pathSeparator¶
plugin.tx_restdoc_pi1.pathSeparator =
t3tsref:data-type-string
Separator to be used between directories of the documentation. You may use multiple characters as well.
Warning
Make sure to read http://forge.typo3.org/issues/45560 before using special characters such as \
(backslash)
or /
(forward slash).
Hint
Since version 1.5, the forward slash is properly supported when using EXT:realurl but it requires a proper configuration as suggested in the chapter describing how to install this extension.
fallbackPathSeparator¶
plugin.tx_restdoc_pi1.fallbackPathSeparator =
t3tsref:data-type-string
Comma-separated list of fallback path separators.
When a documentation structure has been indexed (e.g., by Google) with an old directory separator (such as the backslash
\
), the indexed page cannot be shown anymore and fails with a page not found exception (Error code 404).
documentStructureMaxDocuments¶
plugin.tx_restdoc_pi1.documentStructureMaxDocuments =
t3tsref:data-type-integer
Maximal number of documents to be processed at once when generating the documentation’s structure (requires EXT:dd_googlesitemap).
advertiseSphinx¶
plugin.tx_restdoc_pi1.advertiseSphinx =
t3tsref:data-type-boolean
Whether header JS block should be generated to advertise Sphinx to plugins such as Wappalizer.
addHeadPagination¶
plugin.tx_restdoc_pi1.addHeadPagination =
t3tsref:data-type-boolean
Whether pagination links should be added to the HEAD part. See Google’s Webmaster Central Blog for additional information.
publishSources¶
plugin.tx_restdoc_pi1.publishSources =
t3tsref:data-type-boolean
If active, the sources of your documentation (content of directory _sources/
will be published. Please note that
this flag should be set if you want to show a context of where a search term was found.