Loading...
 
Ich! Plugin PrefDoc
This wiki plugin generates and displays preference documentation for use on doc.tiki.org website.

  • This will automatically record and keep past preference versions.
  • It automatically re-caches the current tiki preferences every time the version number increases (like from 17.0 to 17.1)
  • You may force a re-cache by emptying all caches (will only re-load current version)
  • If description, hint or help (link) are added to a new version of tiki, it populates past versions that are missing that information
  • Images specified for past version of tiki be used for up to 5 newer versions if no other images exist
  • Preference data is stored as it is in tiki to allow for maximum expansion in the future with backwards compatibility (like if color coding for basic-advanced-experimental was to be implemented etc.)
  • Plugin visual appearance is independent from storage, allowing for dramatic future style changes.
  • If an invalid, or non-existent tab-name is given, a list of available options will be presented.


Parameters

Introduced in Tiki 17.
Preferences required: wikiplugin_prefdoc
Parameters Accepted Values Description Default Since
img text Show images at the top of each version of Tiki. Format: TikiVersion:FileGalleryID. Multiple images my be separated like so: TikiVersion1:FileGalleryID1|TikiVersion2:FileGalleryID2. 17
tab text The name of the preference tab to display, or a list of available tabs upon invalid. 17


Example

Generate list of available preferences to display

This code:
{PREFDOC()/}




Display Look and Feel: General Layout, with images

There are 2 images specified. Tiki 17 image has a file gallery id of 33 and the Tiki 14 image has a file gallery id of 12.
This code:
{PREFDOC(tab="look-generallayout" img="17:33|14:12")/}


File is not an image.
Option Description Default
Site logo and title Display a site logo image and/or title in the page header area.
This setting is expected to be moved from here to the admin-modules page.
Enabled
Logo source (image path) This can be a conventional path to the image file, or the syntax for an image in a Tiki gallery. img/tiki/Tiki_WCG.png
Site icon This is to be used in narrow (top to bottom) page headers. In some layouts, the site logo is scaled down to fit.
Recommended image height: 32 pixel
img/tiki/tikilogo_icon.png
Logo background color A legacy option to add a background color to the div that contains the logo image.
Examples: 1) silver - 2) #fff
Transparent
Logo title (on mouseover) This appears as tool tip text. The site logo is also a link to the site index (top page). Tiki powered site
HTML “alt” tag description Normally a description of the image, such as “Example.com logo”.
Used by text browsers, screen readers, etc.
Site Logo
Site title The displayed title of the website. None
Subtitle A short descriptive phrase. None
Left column Controls visibility of the left column of modules
Only if one or more modules are assigned | Always | User decides | Never
Only if one or more modules...
Right column Controls visibility of the right column of modules
Only if one or more modules are assigned | Always | User decides | Never
Only if one or more modules...
Top module zone Activate zone for modules such as site logo, log-in form, etc. (page header)
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Topbar module zone Activate zone for modules such as horizontal menu (navbar), search form, page-wide content, etc.
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Page top module zone Activate zone for modules such as breadcrumbs, banners, share icons, etc
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Page bottom module zone Activate zone for modules at the bottom of the main column of each page
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Bottom module zone Activate zone for modules such as “powered by” and “rss list” (page footer)
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Module file Use a static module definition file instead of relying on the dynamic values generated by Tiki. Useful for custom themes. The file must be in YAML format, following the format used in profiles. None
Extra module zones available Extra module zones to be managed through the module administration interface. Useful if your custom theme requires a special zone other than the predefined ones.
Comma-separated list, maximum of 20 characters per entry.
None
Webmaster report This activates the feature to report a problematic page to the webmaster. Disabled
Webmaster email A specific email address can be set for receiving the webmaster reports.
Leave blank to use the default sender email
None
Email this page This enables users to share a page with others, by emailing a short message and link to the page.
Adds a link at the bottom if set, otherwise adds a link at the top
Disabled

look-generallayout
Tiki 14 Preferences Image
Option Description Default
Site logo and title Display a site logo image and/or title
This setting is expected to be moved from here to the admin-modules page .
Enabled
Logo source (image path) This can be a conventional path to the image file, or the syntax for an image in a Tiki gallery. img/tiki/Tiki_WCG.png
Site icon This is to be used in narrow (top to bottom) page headers. In some layouts, the site logo is scaled down to fit.
Recommended image height: 32 pixel
img/tiki/tikilogo_icon.png
Logo background color A legacy option to add a background color to the div that contains the logo image.
Examples: 1) silver - 2) #fff
Transparent
Logo title (on mouseover) This appears as tool tip text. The site logo is also a link to the site index (top page). Tiki powered site
HTML “alt” tag description (for text browsers, screen readers, etc.) Normally a description of the image, such as “Example.com logo”.
Used by text browsers, screen readers, etc.
Site Logo
Site title The displayed title of the website. None
Subtitle A short descriptive phrase. None
Left column Controls visibility of the left column of modules
Only if one or more modules are assigned | Always | User decides | Never
Only if one or more modules...
Right column Controls visibility of the right column of modules
Only if one or more modules are assigned | Always | User decides | Never
Only if one or more modules...
Top module zone Activate zone for modules such as site logo, log-in form, etc. (page header)
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Topbar module zone Activate zone for modules such as horizontal menu (navbar), search form, page-wide content, etc.
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Page top module zone Activate zone for modules such as breadcrumbs, banners, share icons, etc
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Page bottom module zone Activate zone for modules at the bottom of the main column of each page
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Bottom module zone Activate zone for modules such as “powered by” and “rss list” (page footer)
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Module file Use a static module definition file instead of relying on the dynamic values generated by Tiki. Useful for custom themes. The file must be in YAML format, following the format used in profiles. None
Extra module zones available Extra module zones to be managed through the module administration interface. Useful if your custom theme requires a special zone other than the predefined ones.
Comma-separated list, maximum of 20 characters per entry.
None
Webmaster report This activates the feature to report a problematic page to the webmaster. Disabled
Webmaster email A specific email address can be set for receiving the webmaster reports.
Leave blank to use the default sender email
None
Email this page Add a link at the bottom if set, otherwise add a link at the top
Adds a link at the bottom if set, otherwise adds a link at the top
Disabled

look-generallayout
Tiki 14 Preferences Image
Option Description Default
Site logo and title Display a site logo image and/or title
This setting is expected to be moved from here to the admin-modules page .
Enabled
Logo source (image path) This can be a conventional path to the image file, or the syntax for an image in a Tiki gallery. img/tiki/Tiki_WCG.png
Site icon This is to be used in narrow (top to bottom) page headers. In some layouts, the site logo is scaled down to fit.
Recommended image height: 32 pixel
img/tiki/tikilogo_icon.png
Logo background color A legacy option to add a background color to the div that contains the logo image.
Examples: 1) silver - 2) #fff
Transparent
Logo title (on mouseover) This appears as tool tip text. The site logo is also a link to the site index (top page). Tiki powered site
HTML “alt” tag description (for text browsers, screen readers, etc.) Normally a description of the image, such as “Example.com logo”.
Used by text browsers, screen readers, etc.
Site Logo
Site title The displayed title of the website. None
Subtitle A short descriptive phrase. None
Left column Controls visibility of the left column of modules
Only if one or more modules are assigned | Always | User decides | Never
Only if one or more modules...
Right column Controls visibility of the right column of modules
Only if one or more modules are assigned | Always | User decides | Never
Only if one or more modules...
Top module zone Activate zone for modules such as site logo, log-in form, etc. (page header)
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Topbar module zone Activate zone for modules such as horizontal menu (navbar), search form, page-wide content, etc.
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Page top module zone Activate zone for modules such as breadcrumbs, banners, share icons, etc
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Page bottom module zone Activate zone for modules at the bottom of the main column of each page
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Bottom module zone Activate zone for modules such as “powered by” and “rss list” (page footer)
Only if one or more modules are assigned | Always | Never
Only if one or more modules...
Module file Use a static module definition file instead of relying on the dynamic values generated by Tiki. Useful for custom themes. The file must be in YAML format, following the format used in profiles. None
Extra module zones available Extra module zones to be managed through the module administration interface. Useful if your custom theme requires a special zone other than the predefined ones.
Comma-separated list, maximum of 20 characters per entry.
None
Webmaster report This activates the feature to report a problematic page to the webmaster. Disabled
Webmaster email A specific email address can be set for receiving the webmaster reports.
Leave blank to use the default sender email
None
Email this page Add a link at the bottom if set, otherwise add a link at the top
Adds a link at the bottom if set, otherwise adds a link at the top
Disabled

look-generallayout
Tiki 14 Preferences Image
Option Description Default
Site Logo and Title use a Site Logo and Title
Expected to be migrated to modules entirely and made obsolete.
Enabled
Logo source (image path) This can be a conventional path to the image file, or the syntax for an image in a Tiki gallery. img/tiki/Tiki_WCG.png
Logo background color A legacy option to add a background color to the div that contains the logo image.
Examples: 1) silver - 2) #fff
Transparent
Logo title (on mouse over) This appears as tool tip text. The site logo is also a link to the site index (top page). Tiki powered site
Alt. description (e.g. for text browsers) Normally a description of the image, such as “Example.com logo”.
Used by text browsers, screen readers, etc.
Site Logo
Site title The displayed title of the website. None
Subtitle A short descriptive phrase. None
Top module zone Visibility of area to keep modules such as logo, login etc (header)
Only if module | Always | Never
Only if module
Topbar module zone Visibility of area for modules such as main horizontal menu, search form, page-wide content, etc.
Only if module | Always | Never
Only if module
Page top module zone Visibility of area to keep modules such as share etc
Only if module | Always | Never
Only if module
Left column Controls visibility of the left column of modules
Only if module | Always | User Decides | Never
Only if module
Right Column Controls visibility of the right column of modules
Only if module | Always | User Decides | Never
Only if module
Page bottom module zone Visibility of area to keep modules at the foot of each page
Only if module | Always | Never
Only if module
Bottom module zone Visibility of area to keep modules such as “powered by” and “rss list” (footer)
Only if module | Always | Never
Only if module
Module file Use a static module definition file instead of relying on the dynamic values generated by Tiki. Useful for custom themes. The file must be in YAML format, following the format used in profiles. None
Extra module zones available Extra module zones to be managed through the module administration interface. Useful if your custom theme requires a special zone other than the predefined ones.
Comma-separated list, 20 characters max per entry.
None
Webmaster Report This activates the feature to report a problematic page to the webmaster. Disabled
Webmaster Email A specific email address can be set for receiving the webmaster reports.
Leave blank to use the default sender email
None
Email this page Add a link at the bottom if set, otherwise add a link at the top
Adds a link at the bottom if set, otherwise adds a link at the top
Disabled

Option Description Default
Site Logo and Title use a Site Logo and Title
Expected to be migrated to modules entirely and made obsolete.
Enabled
Logo source (image path) This can be a conventional path to the image file, or the syntax for an image in a Tiki gallery. img/tiki/Tiki_WCG.png
Logo background color A legacy option to add a background color to the div that contains the logo image.
Examples: 1) silver - 2) #fff
Transparent
Logo title (on mouse over) This appears as tool tip text. The site logo is also a link to the site index (top page). Tiki powered site
Alt. description (e.g. for text browsers) Normally a description of the image, such as “Example.com logo”.
Used by text browsers, screen readers, etc.
Site Logo
Site title The displayed title of the website. None
Subtitle A short descriptive phrase. None
Top module zone Visibility of area to keep modules such as logo, login etc (header)
Only if module | Always | Never
Only if module
Topbar module zone Visibility of area for modules such as main horizontal menu, search form, page-wide content, etc.
Only if module | Always | Never
Only if module
Page top module zone Visibility of area to keep modules such as share etc
Only if module | Always | Never
Only if module
Left column Controls visibility of the left column of modules
Only if module | Always | User Decides | Never
Only if module
Right Column Controls visibility of the right column of modules
Only if module | Always | User Decides | Never
Only if module
Page bottom module zone Visibility of area to keep modules at the foot of each page
Only if module | Always | Never
Only if module
Bottom module zone Visibility of area to keep modules such as “powered by” and “rss list” (footer)
Only if module | Always | Never
Only if module
Module file Use a static module definition file instead of relying on the dynamic values generated by Tiki. Useful for custom themes. The file must be in YAML format, following the format used in profiles. None
Extra module zones available Extra module zones to be managed through the module administration interface. Useful if your custom theme requires a special zone other than the predefined ones.
Comma-separated list, 20 characters max per entry.
None
Webmaster Report This activates the feature to report a problematic page to the webmaster. Disabled
Webmaster Email A specific email address can be set for receiving the webmaster reports.
Leave blank to use the default sender email
None
Email this page Add a link at the bottom if set, otherwise add a link at the top
Adds a link at the bottom if set, otherwise adds a link at the top
Disabled

Option Description Default
Site Logo and Title use a Site Logo and Title
Expected to be migrated to modules entirely and made obsolete.
Enabled
Logo source (image path) This can be a conventional path to the image file, or the syntax for an image in a Tiki gallery. img/tiki/Tiki_WCG.png
Logo background color A legacy option to add a background color to the div that contains the logo image.
Examples: 1) silver - 2) #fff
Transparent
Logo title (on mouse over) This appears as tool tip text. The site logo is also a link to the site index (top page). Tiki powered site
Alt. description (e.g. for text browsers) Normally a description of the image, such as “Example.com logo”.
Used by text browsers, screen readers, etc.
Site Logo
Site title The displayed title of the website. None
Subtitle A short descriptive phrase. None
Top module zone Visibility of area to keep modules such as logo, login etc (header)
Only if module | Always | Never
Only if module
Topbar module zone Visibility of area for modules such as main horizontal menu, search form, page-wide content, etc.
Only if module | Always | Never
Only if module
Page top module zone Visibility of area to keep modules such as share etc
Only if module | Always | Never
Only if module
Left column Controls visibility of the left column of modules
Only if module | Always | User Decides | Never
Only if module
Right Column Controls visibility of the right column of modules
Only if module | Always | User Decides | Never
Only if module
Page bottom module zone Visibility of area to keep modules at the foot of each page
Only if module | Always | Never
Only if module
Bottom module zone Visibility of area to keep modules such as “powered by” and “rss list” (footer)
Only if module | Always | Never
Only if module
Module file Use a static module definition file instead of relying on the dynamic values generated by Tiki. Useful for custom themes. The file must be in YAML format, following the format used in profiles. None
Extra module zones available Extra module zones to be managed through the module administration interface. Useful if your custom theme requires a special zone other than the predefined ones.
Comma-separated list, 20 characters max per entry.
None
Webmaster Report This activates the feature to report a problematic page to the webmaster. Disabled
Webmaster Email A specific email address can be set for receiving the webmaster reports.
Leave blank to use the default sender email
None
Email this page Add a link at the bottom if set, otherwise add a link at the top
Adds a link at the bottom if set, otherwise adds a link at the top
Disabled








doc.tiki.org


Bootstrap

AdminGuide

UserGuide

Keywords

Keywords serve as “hubs” for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Accounting (7.x)
Articles and Submissions
Backlinks
Banners
Batch (6.x)
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Contribution (2.x)
Cookie
Copyright
Credit (6.x)
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Docs 8.x
Draw 7.x
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
Kaltura video management (4.x)
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tags
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Report
Toolbar
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Search and Replace
Security
Semantic links (3.x)
Shadowbox
Shadow Layers
Share
Shopping cart
Shoutbox
Slideshow
Smiley
Social Networks
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags (2.x)
Task
Tell a Friend, alert + Social Bookmarking
TikiTests (2.x)
Theme CSS & Smarty
Trackers
Transitions (5.x)
TRIM
User Administration including registration and banning
User Files
User Menu
Watch
WebHelp
WebDAV (5.x)
Webmail
Web Services
Wiki 3D
Wiki History, page rename, etc
Wiki Page Staging and Approval (2.x)
Wiki Plugin extends basic syntax
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WSOD
WYSIWYCA
WYSIWYG (2.x)
XMLRPC

Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki
Show php error messages