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

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")/}

Error: Cant find look-generallayout you may choose from one of the following: ads
articles-articleslistingandview
articles-generalsettings
blogs-blogslistings
blogs-generalsettings
calendar
category
comments
community-communityfeatures
community-plugins
community-socialinteraction
connect-jitsi
connect-settings
copyright
directory
faqs
features-globalfeatures
features-interface
features-programmer
fgal-adminlistings
fgal-enhancements
fgal-generalsettings
fgal-listings
fgal-plugins
fgal-searchindexing
forums-forumlisting
forums-generalsettings
freetags
gal-features
general-dateandtime
general-generalpreferences
general-generalsettings
general-navigation
i18n
intertiki-intertikiclient
intertiki-intertikimasterserver
login-cas
login-generalpreferences
login-ldap
login-ldapexternalgroups
login-oauthserversettings
login-pam
login-passwordblacklist
login-phpbb
login-remotetikiautologin
login-saml2
login-shibboleth
login-webserver
look-customization
look-layout
look-miscellaneous
look-pagination
look-shadowlayer
look-theme
look-uieffects
maps
messages
metatags-geometatags
metatags-metatags
metatags-robots
module
payment-advancedshoppingcart
payment-payment
payment-plugins
payment-shipping
performance-database
performance-majorslowdown
performance-memcache
performance-newsletter
performance-performance
performance-plugins
performance-redis
performance-sessions
performance-timeandmemorylimits
performance-wiki
polls-polls
polls-surveys
print
profiles-advanced
rating
rss-feeds
rss-generalpreferences
rss-incomingfeeds
rtc-bigbluebutton
rtc-xmpp
score
search-federatedsearch
search-generalsettings
search-searchresults
search-storedsearch
security-generalsecurity
security-openpgp
security-searchresults
security-siteaccess
security-spamprotection
security-tokens
sefurl
semantic
share
socialnetworks-bit
socialnetworks-facebook
socialnetworks-general
socialnetworks-linkedin
socialnetworks-sharethis
socialnetworks-twitter
stats-googleanalytics
stats-piwikanalytics
stats-tikistatistics
textarea-generalsettings
textarea-plugins
trackers-plugins
trackers-settings
user-messagingandnotifications
user-userfeatures
user-userfiles
user-userinfoandpicture
user-usersettings
video-kaltura
webservices
wiki-features
wiki-flaggedrevision
wiki-generalpreferences
wiki-pagelistings
wiki-tools
workspace-areas
workspace-workspaces
wysiwyg
login-openidconnect
security-api
socialnetworks-legacyintegrations
mautic
security-webhooks
trackers-systemtrackers
ads-activatethefeature
ads-plugins
ads-siteadsandbanners
articles-articleslistingandview-articleview
articles-articleslistingandview-listarticles
articles-generalsettings-activatethefeature
articles-generalsettings-features
articles-generalsettings-plugins
articles-generalsettings-sharingonsocialnetworks
blogs-blogslistings-itemstodisplay
blogs-generalsettings-activatethefeature
blogs-generalsettings-comments
blogs-generalsettings-features
blogs-generalsettings-plugins
blogs-generalsettings-sharingonsocialnetworks
calendar-activatethefeature
calendar-generalsettings
calendar-plugins
category-activatethefeature
category-categoryobjects
category-features
category-forum
category-inlineplugins
category-performance
category-plugins
category-poll
category-structure
category-theme
category-tracker
category-wiki
comments-annotations
comments-displayoptions
comments-sitewidefeatures
comments-usingcommentsinvariousfeatures
community-communityfeatures-additionaloptions
community-communityfeatures-community
community-socialinteraction-activitystream
community-socialinteraction-friendshipandfollowers
community-socialinteraction-goalrecognitionandrewards
community-socialinteraction-score
community-socialinteraction-selectwhichitemstodisplaywhenlistingusers
connect-jitsi-jitsi
connect-settings-tikiconnect
copyright-activatethefeature
copyright-features
directory-activatethefeature
directory-directory
faqs-activatethefeature
faqs-settings
features-globalfeatures-3
features-globalfeatures-4
features-globalfeatures-additionalfeatures
features-globalfeatures-administrativefeatures
features-globalfeatures-interactionwithonlineservicesorothersoftware
features-globalfeatures-mailandsharing
features-globalfeatures-mainfeatures
features-globalfeatures-paymentandaccounting
features-globalfeatures-progressivewebapp
features-globalfeatures-secondaryfeatures
features-interface-ajax
features-interface-experimental
features-interface-jquerypluginsandaddons
features-programmer-customcode
features-programmer-loggingandreporting
fgal-adminlistings-0
fgal-enhancements-access
fgal-enhancements-draw
fgal-enhancements-h5p
fgal-enhancements-scorm
fgal-enhancements-vimeo
fgal-generalsettings-activatethefeature
fgal-generalsettings-features
fgal-generalsettings-quota
fgal-generalsettings-settingsfordiagrams
fgal-generalsettings-settingsformediaalchemyst
fgal-generalsettings-settingsforrecordrtc
fgal-generalsettings-uploadregex
fgal-plugins-plugins
forums-generalsettings-activatethefeature
forums-generalsettings-features
forums-generalsettings-searches
forums-generalsettings-threads
freetags-activatethefeature
freetags-plugins
freetags-tags
freetags-tagsearchpage
general-dateandtime-datetimeselectors
general-dateandtime-timezoneandformat
general-generalpreferences-errortracking
general-generalpreferences-loggingandreporting
general-generalpreferences-mail
general-generalpreferences-newsletter
general-generalpreferences-schedulersettings
general-generalpreferences-siteidentity
general-generalpreferences-webcron
general-generalsettings-contact
general-generalsettings-help
general-generalsettings-multidomain
general-generalsettings-server
general-generalsettings-sessions
general-generalsettings-siteterminal
general-generalsettings-stats
general-generalsettings-termsandconditions
general-navigation-breadcrumbs
general-navigation-homepage
general-navigation-menus
general-navigation-namespace
general-navigation-redirects
general-navigation-siteaccess
general-navigation-sitemapprotocol
general-navigation-user
intertiki-intertikiclient-activatethefeature
intertiki-intertikiclient-clientserversettings
intertiki-intertikiclient-currentlylinkedmasterserver
intertiki-intertikimasterserver-activatethefeature
intertiki-intertikimasterserver-masterserversettings
login-cas-cascentralauthenticationservice
login-cas-casserver
login-generalpreferences-captcha
login-generalpreferences-cookies
login-generalpreferences-password
login-generalpreferences-registration
login-generalpreferences-username
login-ldap-ldapadmin
login-ldap-ldapbindsettings
login-ldap-ldapuser
login-ldap-warning
login-ldapexternalgroups-ldapadmin
login-ldapexternalgroups-ldapbindsettings
login-ldapexternalgroups-ldapexternalgroups
login-ldapexternalgroups-ldapgroup
login-ldapexternalgroups-ldapgroupmemberifgroupmembershipcanbefoundingroupattributes
login-ldapexternalgroups-ldapuser
login-ldapexternalgroups-ldapusergroupifgroupmembershipcanbefoundinuserattributes
login-oauthserversettings-0
login-openidconnect-0
login-pam-pam
login-passwordblacklist-password
login-phpbb-phpbb
login-remotetikiautologin-warning
login-saml2-advancedsettings
login-saml2-attributemapping
login-saml2-groupmapping
login-saml2-identityprovidersettings
login-saml2-options
login-saml2-saml2
login-shibboleth-shibboleth
login-webserver-webserver
look-customization-customcode
look-customization-editing
look-layout-logo
look-layout-modulezonevisibility
look-layout-sitereportbar
look-layout-title
look-miscellaneous-contextmenus
look-miscellaneous-favicons
look-miscellaneous-responsiveimages
look-miscellaneous-separators
look-miscellaneous-tabs
look-uieffects-other
look-uieffects-standarduieffects
look-uieffects-tabuieffects
maps-defaults
maps-settings
mautic-credentials
mautic-mainsettings
messages-activatethefeature
messages-settings
metatags-metatags-facebook
metatags-metatags-general
metatags-metatags-twitter
module-crumbscrumbdescription
module-modulezonevisibility
payment-advancedshoppingcart-advancedcarttrackernamessetup
payment-advancedshoppingcart-cartsettings
payment-advancedshoppingcart-features
payment-advancedshoppingcart-productstrackersetup
payment-payment-0
payment-plugins-plugins
polls-polls-activatethefeature
polls-polls-plugins
polls-polls-settings
polls-surveys-1
polls-surveys-activatethefeature
print-articles
print-otherfeatures
print-pdfsettings
print-wikiprintversion
profiles-advanced-repositorystatus
rating-advanced
rating-articles
rating-comments
rating-defaultoptions
rating-globalconfiguration
rating-trackers
rating-userinterface
rating-wiki
score-activatethefeature
score-causescoresolderthanacertainnumberofdaystoexpire
search-generalsettings-features
search-generalsettings-filegalleriessearches
search-generalsettings-forumsearches
search-generalsettings-search
search-searchresults-informationtodisplayforeachresult
search-searchresults-itemstodisplayinsearchresults
security-generalsecurity-csrfsecurity
security-generalsecurity-httpheaders
security-generalsecurity-smartyandfeaturessecurity
security-generalsecurity-userencryption
security-openpgp-openpgpfunctionalityforpgpmimeencryptedemailmessaging
security-spamprotection-captcha
sefurl-activatethefeature
sefurl-settings
semantic-activatethefeature
share-activatethefeature
share-sitewidefeatures
socialnetworks-legacyintegrations-facebook
socialnetworks-legacyintegrations-linkedin
socialnetworks-legacyintegrations-warning
stats-googleanalytics-0
stats-piwikanalytics-0
stats-tikistatistics-0
textarea-generalsettings-defaultsize
textarea-generalsettings-externallinksandimages
textarea-generalsettings-features
textarea-generalsettings-markdown
textarea-generalsettings-miscellaneous
textarea-generalsettings-plugins
textarea-generalsettings-typography
textarea-generalsettings-wikisyntax
textarea-plugins-editpluginicons
textarea-plugins-filter
textarea-plugins-pluginpreferences
textarea-plugins-plugins
trackers-plugins-0
trackers-settings-activatethefeature
trackers-settings-fieldsettings
trackers-settings-linkedwikipages
trackers-settings-trackerattachmentpreferences
trackers-settings-trackerforcefillfeature
trackers-settings-trackersettings
trackers-systemtrackers-systemtrackers
user-messagingandnotifications-messages
user-messagingandnotifications-usernotifications
user-userfeatures-useraccountfeatures
user-userfiles-activatethefeature
user-userfiles-settings
user-userinfoandpicture-profilepicture
user-userinfoandpicture-userinformationdisplay
user-usersettings-adminuserpreferences
user-usersettings-defaultuserpreferences
video-kaltura-activatethefeature
video-kaltura-enablerelatedtrackerfieldtypes
video-kaltura-kalturadynamicplayer
video-kaltura-kalturapartnersettings
video-kaltura-kalturatikiconfig
video-kaltura-legacysupport
video-kaltura-plugintoembedinpages
webservices-activatethefeature
webservices-options
wiki-features-attachments
wiki-features-comments
wiki-features-generalfeatures
wiki-features-namespaces
wiki-features-redirectandsimilar
wiki-features-structures
wiki-features-wikiwatch
wiki-features-wikiwordsfeatures
wiki-flaggedrevision-0
wiki-generalpreferences-activatethefeature
wiki-generalpreferences-automatictableofcontents
wiki-generalpreferences-editing
wiki-generalpreferences-pagedisplay
wiki-generalpreferences-pagename
wiki-generalpreferences-plugins
wiki-pagelistings-configuration
wiki-pagelistings-options
workspace-areas-activatethefeature
workspace-workspaces-activatethefeature
workspace-workspaces-advanced
workspace-workspaces-dependencies
wysiwyg-activatethefeature
wysiwyg-legacyckeditorwysiwyg
wysiwyg-markdowntoastuiwysiwyg
wysiwyg-relatedfeatures
wysiwyg-wysiwygeditorfeatures
features-interface-elementplus
performance-monitor