plugin.tx_restdoc_pi1¶

path¶

plugin.tx_restdoc_pi1.path = string

Path to the root directory of the documentation.

defaultFile¶

plugin.tx_restdoc_pi1.defaultFile = string

Default file (main file).

mode¶

plugin.tx_restdoc_pi1.mode = 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 = 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 = boolean

Whether permanent links should be added to each section.

pathSeparator¶

plugin.tx_restdoc_pi1.pathSeparator = string

Separator to be used between directories of the documentation. You may use multiple characters as well.

fallbackPathSeparator¶

plugin.tx_restdoc_pi1.fallbackPathSeparator = 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 = 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 = boolean

Whether header JS block should be generated to advertise Sphinx to plugins such as Wappalizer.

addHeadPagination¶

plugin.tx_restdoc_pi1.addHeadPagination = 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 = 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.

baseWrap¶

plugin.tx_restdoc_pi1.baseWrap = stdWrap

Override the default wrap for the plugin:

<div class="tx-restdoc-pi1">
    ...
</div>