History: Module and Plugin Includes

• «
• »

            ! Module and Plugin Includes
Contains blocks of text that need to be repeated on each of the module and plugin documentation pages. The Related Pages section text can be placed here, for instance, and then shown on each plugin page through the ((PluginInclude)) so that it can be updated centrally here.

Also, links to frequently used icons are included below and the attached photos here are used throughout the module and plugin pages through use of ((PluginAttach)).

The point where the include starts is noted by  "startincludeX", and where the include stops is indicted by "stopincludeX" before and after the text, where X is the number of the include.


!! Related Pages for Module Pages
Here is the related pages section for use on the pages where each module is documented:
startinclude1
!! Related Pages
See these pages for information that applies for all modules:
* ((Module)) -- Overall introduction and overview
* ((Module Admin)) -- Introduction to the module admin pages for site-wide and individual module settings
** ((Assigning Modules)) -- How to select a module to configure it
** ((Module Settings Interface)) -- Interface for configuring individual module settings
** ((Module Settings Parameters)) -- Explanation of standard parameter settings for modules
** ((Creating Custom Modules)) -- How to create user modules
* ((Index of Modules)) -- Links to the documentation of individual modules
* ((User Modules)) -- How (if the feature is active) users can choose and place their modules 
* ((Mods Type Modules)) -- Links to modules that are installed as components
stopinclude1

''Since Tiki6 headings from includes are not showing up correctly in the maketoc plugin, so use the below as a workaround:''
startinclude1a
See these pages for information that applies for all modules:
* ((Module)) -- Overall introduction and overview
* ((Module Admin)) -- Introduction to the module admin pages for site-wide and individual module settings
** ((Assigning Modules)) -- How to select a module to configure it
** ((Module Settings Interface)) -- Interface for configuring individual module settings
** ((Module Settings Parameters)) -- Explanation of standard parameter settings for modules
** ((Creating Custom Modules)) -- How to create user modules
* ((Index of Modules)) -- Links to the documentation of individual modules
* ((User Modules)) -- How (if the feature is active) users can choose and place their modules 
* ((Mods Type Modules)) -- Links to modules that are installed as components
stopinclude1a

!! Related Pages for Plugin Pages
Here is the related pages section for use on the pages where each plugin is documented:

startinclude2
!! Related pages
* ((Wiki Plugin)) - has links to all plugins and describes how the syntax works for a plugin
* ((Mods Type Wikiplugins))
stopinclude2

And here is the code to include the above text block on a page:
{CODE(caption=>Include code, wrap=>1)}{include page="Module and Plugin Includes" start="startinclude2" stop="stopinclude2"}{CODE}

''Since Tiki6 headings from includes are not showing up correctly in the maketoc plugin, so use the below as a workaround:''
startinclude3
* ((Wiki Plugin)) - has links to all plugins and describes how the syntax works for a plugin
* ((Mods Type Wikiplugins))
stopinclude3


!!! Frequently Used Icons
{FANCYTABLE(head=> __Icon__ ~|~ __Tag to Include on a Page__)}
{ATTACH(page=>Module and Plugin Includes,file=>arrow-right.png, image=>1)} {ATTACH} ~|~ ~np~{ATTACH(page=>Module and Plugin Includes,file=>arrow-right.png, image=>1)} {ATTACH} ~/np~
{img src="img/icons/book_open.png"} ~|~ ~np~ {img src="img/icons/book_open.png"} ~/np~
{img src="img/smiles/icon_exclaim.gif"} ~|~ ~np~ {img src="img/smiles/icon_exclaim.gif"} ~/np~
{FANCYTABLE}