wiki:template:bootstrap3:config

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki:template:bootstrap3:config [2016/04/13 22:59]
Giuseppe Di Terlizzi
wiki:template:bootstrap3:config [2018/02/21 22:24] (current)
Giuseppe Di Terlizzi
Line 8: Line 8:
  
 (This adds a button to turn on / off fluid layout. See the fluidContainerBtn option below.) (This adds a button to turn on / off fluid layout. See the fluidContainerBtn option below.)
- 
  
 ==== Theme ==== ==== Theme ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''bootstrapTheme'' | Bootstrap theme | ''default''+| ''bootstrapTheme'' | Bootstrap theme | multichoice | ''default'' | ''default'' \\ ''optional'' \\ ''custom'' \\ ''bootswatch''
-| ''bootswatchTheme'' | Select a theme from Bootswatch.com | ''spacelab''+| ''bootswatchTheme'' | Select a theme from Bootswatch.com | multichoice ''yeti'' | ''cerulean'' \\ ''cosmo'' \\ ''cyborg'' \\ ''darkly'' \\ ''flatly'' \\ ''journal'' \\ ''lumen'' \\ ''paper'' \\ ''readable'' \\ ''sandstone'' \\ ''simplex'' \\ ''solar'' \\ ''slate'' \\ ''spacelab'' \\ ''superhero'' \\ ''united'' \\ ''yeti''
-| ''customTheme'' | Insert URL of custom theme | ''null''+| ''customTheme'' | Insert URL of custom theme | string | ''null'' |  
-| ''showThemeSwitcher'' | Show Bootswatch.com theme switcher in navbar | ''0''+| ''showThemeSwitcher'' | Show Bootswatch.com theme switcher in navbar | onoff | ''0'' |  
-| ''hideInThemeSwitcher'' | Hide themes in theme switcher | ''null''+| ''hideInThemeSwitcher'' | Hide themes in theme switcher | multicheckbox | ''null'' | ''cerulean'' \\ ''cosmo'' \\ ''cyborg'' \\ ''darkly'' \\ ''flatly'' \\ ''journal'' \\ ''lumen'' \\ ''paper'' \\ ''readable'' \\ ''sandstone'' \\ ''simplex'' \\ ''solar'' \\ ''slate'' \\ ''spacelab'' \\ ''superhero'' \\ ''united'' \\ ''yeti''
-| ''useLocalBootswatch'' | Use the local Bootswatch directory. This option is useful in "intranet" DokuWiki installation | ''1'' |+| ''useLocalBootswatch'' | Use the local Bootswatch directory. This option is useful in "intranet" DokuWiki installation | onoff | ''1'' |  | 
 +| ''themeByNamespace'' | Use a namespaced theme | onoff | ''0'' |  |
  
  
 ==== Sidebar ==== ==== Sidebar ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''sidebarPosition'' | DokuWiki Sidebar position (''left'' or ''right'') | ''left''+| ''sidebarPosition'' | DokuWiki Sidebar position (''left'' or ''right''| multichoice | ''left'' | ''left'' \\ ''right''
-| ''rightSidebar'' | The Right Sidebar page name, empty field disables the right sidebar. \\ The Right Sidebar is displayed only when the default DokuWiki [[doku>config:sidebar|sidebar]] is enabled and is on the ''left'' position (see the ''sidebarPosition'' configuration). If do you want only the DokuWiki sidebar on right position, set the ''sidebarPosition'' configuration with ''right'' value | ''rightsidebar''+| ''rightSidebar'' | The Right Sidebar page name, empty field disables the right sidebar. \\ The Right Sidebar is displayed only when the default DokuWiki [[config:sidebar|sidebar]] is enabled and is on the ''left'' position (see the [[sidebar-position|sidebarPosition]] configuration). If do you want only the DokuWiki sidebar on right position, set the [[sidebar-position|sidebarPosition]] configuration with ''right'' value | string | ''rightsidebar'' |  
-| ''leftSidebarGrid'' | Left sidebar grid classes ''col-{xs,sm,md,lg}-x'' (see [[http://getbootstrap.com/css/#grid|Bootstrap Grids]] documentation) | ''col-sm-3 col-md-2''+| ''leftSidebarGrid'' | Left sidebar grid classes ''col-{xs,sm,md,lg}-x'' (see [[http://getbootstrap.com/css/#grid|Bootstrap Grids]] documentation) | string | ''col-sm-3 col-md-2'' |  
-| ''rightSidebarGrid'' | Right sidebar grid classes ''col-{xs,sm,md,lg}-x'' (see [[http://getbootstrap.com/css/#grid|Bootstrap Grids]] documentation) | ''col-sm-3 col-md-2'' |+| ''rightSidebarGrid'' | Right sidebar grid classes ''col-{xs,sm,md,lg}-x'' (see [[http://getbootstrap.com/css/#grid|Bootstrap Grids]] documentation) | string | ''col-sm-3 col-md-2'' |  | 
 +| ''sidebarOnNavbar'' | Display the sidebar contents inside the navbar (useful on mobile/tablet devices) | onoff | ''0'' |  | 
 +| ''sidebarShowPageTitle'' | Display Sidebar page title | onoff | ''1'' |  |
  
  
 ==== Navbar ==== ==== Navbar ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''inverseNavbar'' | Inverse navbar | ''0''+| ''inverseNavbar'' | Inverse navbar | onoff | ''0'' |  
-| ''fixedTopNavbar'' | Fix navbar to top | ''0''+| ''fixedTopNavbar'' | Fix navbar to top | onoff | ''0'' |  
-| ''showTranslation'' | Display translation toolbar (require //Translation Plugin//) | ''0''+| ''showTranslation'' | Display translation toolbar (require //Translation Plugin//| onoff | ''0'' |  
-| ''showTools'' | Display Tools in navbar | ''always''+| ''showTools'' | Display Tools in navbar | multichoice ''always'' | ''never'' \\ ''logged'' \\ ''always''
-| ''showHomePageLink'' | Display Home-Page link in navbar | ''0''+| ''showHomePageLink'' | Display Home-Page link in navbar | onoff | ''0'' |  | 
-| ''showUserHomeLink'' | Display User Home-Page link in navbar | ''1''+| ''homePageURL'' | Use custom URL for home-page links | string | ''null'' |  
-| ''hideLoginLink'' | Hide the login button in navbar. This option is useful in "read-only" DokuWiki installations (eg. blog, personal website) | ''0''+| ''showUserHomeLink'' | Display User Home-Page link in navbar | onoff | ''1'' |  
-| ''individualTools'' | Split the Tools in individual menu in navbar | ''0''+| ''hideLoginLink'' | Hide the login button in navbar. This option is useful in "read-only" DokuWiki installations (eg. blog, personal website) | onoff | ''0'' |  | 
-| ''showIndividualTool'' | Enable/Disable individual tool in navbar | ''user,site,page''+| ''showEditBtn'' | Display edit button in navbar | multichoice | ''never'' | ''never'' \\ ''logged'' \\ ''always''
-| ''showSearchForm'' | Display Search form in navbar | ''always''+| ''individualTools'' | Split the Tools in individual menu in navbar | onoff | ''0'' |  
-| ''showAdminMenu'' | Display Administration menu | ''0''+| ''showIndividualTool'' | Enable/Disable individual tool in navbar | multicheckbox | ''site,page'' | ''user'' \\ ''site'' \\ ''page''
-| ''useLegacyNavbar'' | Use legacy and deprecated ''navbar.html'' hook (consider in the future to use the '':navbar'' hook) | ''0''+| ''showSearchForm'' | Display Search form in navbar | multichoice ''always'' | ''never'' \\ ''logged'' \\ ''always''
-| ''showNavbar'' | Display navbar hook | ''always'' |+| ''showAdminMenu'' | Display Administration menu | onoff | ''0'' |  
 +| ''useLegacyNavbar'' | Use legacy and deprecated ''navbar.html'' hook (consider in the future to use the '':navbar'' hook) | onoff | ''0'' |  
 +| ''showNavbar'' | Display navbar hook | multichoice | ''always'' | ''logged'' \\ ''always''
 +| ''navbarLabels'' | Show/Hide individual label | multicheckbox | ''login,register'' | ''login'' \\ ''register'' \\ ''admin'' \\ ''tools'' \\ ''user'' \\ ''site'' \\ ''page'' \\ ''themes'' \\ ''expand'' \\ ''profile''
 +| ''showAddNewPage'' | Enable the Add New Page plugin in navbar  (require //Add New Page Plugin//) | multichoice | ''never'' | ''never'' \\ ''logged'' \\ ''always'' |
  
  
 ==== Semantic ==== ==== Semantic ====
  
-Adds Schema.org markup to enable basic support for semantic data. For full support use the [[doku>:plugin:semantic]] plugin.+Adds Schema.org markup to enable basic support for semantic data. For full support use the [[:plugin:semantic]] plugin.
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''semantic'' | Enable semantic data | ''0''+| ''semantic'' | Enable semantic data | onoff | ''1'' |  
-| ''schemaOrgType'' | Schema.org type (''Article'', ''NewsArticle'', ''TechArticle'', ''BlogPosting'', ''Recipe'') | ''Article'' |+| ''schemaOrgType'' | Schema.org type (''Article'', ''NewsArticle'', ''TechArticle'', ''BlogPosting'', ''Recipe''| multichoice | ''Article'' | ''Article'' \\ ''NewsArticle'' \\ ''TechArticle'' \\ ''BlogPosting'' \\ ''Recipe''
 +| ''showSemanticPopup'' | Display a popup with an extract of the page when the user hover on wikilink (require //Semantic Plugin//) | onoff | ''0'' |  |
  
  
 ==== Layout ==== ==== Layout ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''fluidContainer'' | Enable the fluid container (full-width of page) | ''0''+| ''fluidContainer'' | Enable the fluid container (full-width of page) | onoff | ''0'' |  
-| ''fluidContainerBtn'' | Display a button in navbar to expand container | ''0''+| ''fluidContainerBtn'' | Display a button in navbar to expand container | onoff | ''0'' |  
-| ''pageOnPanel'' | Enable the panel around the page | ''1''+| ''pageOnPanel'' | Enable the panel around the page | onoff | ''1'' |  
-| ''tableFullWidth'' | Enable 100% full table width (Bootstrap default) | ''1''+| ''tableFullWidth'' | Enable 100% full table width (Bootstrap default) | onoff | ''1'' |  
-| ''tableStyle'' | Table style | ''striped,condensed,responsive''+| ''tableStyle'' | Table style | multicheckbox | ''striped,condensed,responsive'' | ''striped'' \\ ''bordered'' \\ ''hover'' \\ ''condensed'' \\ ''responsive''
-| ''showLandingPage'' | Enable the landing page (without a sidebar and the panel around the page) | ''0''+| ''showLandingPage'' | Enable the landing page (without a sidebar and the panel around the page) | onoff | ''0'' |  
-| ''landingPages'' | Landing page name (insert a regex) | ''(intro)''+| ''landingPages'' | Landing page name (insert a regex) | regex | ''(intro)'' |  
-| ''showPageTools'' | Enable the DokuWiki-style Page Tools | ''always''+| ''showPageTools'' | Enable the DokuWiki-style Page Tools | multichoice ''always'' | ''never'' \\ ''logged'' \\ ''always''
-| ''showPageId''Display the DokuWiki page name (pageId) on top | ''1''+| ''pageToolsAnimation''Enable the Page Tools animation | onoff | ''1'' |  
-| ''tocCollapseSubSections''Collapse all sub-sections in TOC to save space | ''1''+| ''showPageId''Display the DokuWiki page name (pageId) on top | onoff | ''1'' |  
-| ''showBadges'' | Show badge buttons (DokuWiki, Donate, etc) | ''1''+| ''showBadges'' | Show badge buttons (DokuWiki, Donate, etc) | onoff | ''1'' |  
-| ''showLoginOnFooter'' | Display a "little" login link on footer. This option is useful when ''hideLoginLink'' is on | ''0''+| ''showLoginOnFooter'' | Display a "little" login link on footer. This option is useful when ''hideLoginLink'' is on | onoff | ''0'' |  
-| ''useGravatar''Load Gravatar image | ''0'' |+| ''showWikiInfo''Display DokuWiki [[config:title|name]], logo and [[config:tagline|tagline]] on footer | onoff | ''1'' |  |
  
  
 ==== TOC ==== ==== TOC ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''tocAffix'' | Affix the TOC during page scrolling | ''1''+| ''tocAffix'' | Affix the TOC during page scrolling | onoff | ''1'' |  
-| ''tocCollapseSubSections'' | Collapse all sub-sections in TOC to save space | ''1'' |+| ''tocCollapseSubSections'' | Collapse all sub-sections in TOC to save space | onoff | ''1'' |  | 
 +| ''tocCollapseOnScroll'' | Collapse TOC during page scrolling | onoff | ''1'' |  | 
 +| ''tocCollapsed'' | Collapse TOC on every pages | onoff | ''0'' |  | 
 +| ''tocLayout'' | TOC layout | multichoice | ''default'' | ''default'' \\ ''navbar'' |
  
  
 ==== Discussion ==== ==== Discussion ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''showDiscussion'' | Display discussion link in tools menu | ''0''+| ''showDiscussion'' | Display discussion link in tools menu | onoff | ''0'' |  
-| ''discussionPage'' | Discussion page name (default is ''discussion:@[email protected]'', where ''@[email protected]'' placeholder replace the current page name), empty field disable the link | ''discussion:@[email protected]'' |+| ''discussionPage'' | Discussion page name (default is ''discussion:@[email protected]'', where ''@[email protected]'' placeholder replace the current page name), empty field disable the link | string | ''discussion:@[email protected]'' |  |
  
 +
 +==== Avatar ====
 +
 +^ Option ^ Description ^ Value Type ^ Default Value ^ ^
 +| ''useAvatar'' | Load the avatar image from Gravatar, Libravatar, Microsoft Office365 or local DokuWiki '':user'' namespace | multichoice | ''off'' | ''off'' \\ ''gravatar'' \\ ''libravatar'' \\ ''office365'' \\ ''local'' |
 +| ''gravatarURL'' | Set Gravatar URL  \\  **NOTE:**  \\  - ''http://www.gravatar.com/avatar'' (http)  \\  - ''https://secure.gravatar.com/avatar'' (https)  \\  - ''https://www.gravatar.com/avatar'' (alternative https) | string | ''https://secure.gravatar.com/avatar'' |  |
 +| ''libravatarURL'' | Set Libravatar (or compatible API) URL  \\  **NOTE:**  \\  - ''https://seccdn.libravatar.org/avatar'' (https)  \\  - ''http://cdn.libravatar.org/avatar'' (http) | string | ''https://seccdn.libravatar.org/avatar'' |  |
 +| ''office365URL'' | Set Microsoft Office 365 (or EWS) URL  \\  **NOTE:** This service requires login, so this use case is most useful in a corporate installation, where all users have access to Office 365. | string | ''https://outlook.office365.com'' |  |
 +
 +<callout type="warning" icon="true">
 +=== NOTE ===
 +
 +For local DokuWiki avatar, upload the avatar image with the name of username on user namespace ('':user:<dokuwiki-username>.png'' -- also support ''.jpg'' file extension).
 +</callout>
  
 ==== Cookie Law ==== ==== Cookie Law ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''showCookieLawBanner'' | Display the Cookie Law banner on footer | ''0''+| ''showCookieLawBanner'' | Display the Cookie Law banner on footer | onoff | ''0'' |  
-| ''cookieLawBannerPage'' | Cookie Law banner page name | ''cookie:banner''+| ''cookieLawBannerPage'' | Cookie Law banner page name | string | ''cookie:banner'' |  
-| ''cookieLawPolicyPage'' | Cookie Law policy page name | ''cookie:policy'' |+| ''cookieLawPolicyPage'' | Cookie Law policy page name | string | ''cookie:policy'' |  |
  
-The Cookie Law Banner Notice add a cookie called "cookieNoticeAcceptedto use in your JavaScript/PHP code (eg. to add Google Analytics only when the user accept the policy).+The Cookie Law Banner Notice add a cookie called ''cookieNoticeAccepted'' to use in your JavaScript/PHP code (eg. to add Google Analytics only when the user accept the policy).
  
 **JavaScript Snippet:** **JavaScript Snippet:**
  
-<code javascript> +<file javascript> 
-  if (DokuCookie.getValue('cookieNoticeAccepted')) { +if (DokuCookie.getValue('cookieNoticeAccepted')) { 
-    // Your JS code +  // Your JS code (eg. in userscript.js or in 3th-party plugin) 
-  +
-</code>+</file>
  
 **PHP Snippet:** **PHP Snippet:**
  
-<code php> +<file php> 
-  if ( ! (get_doku_pref('cookieNoticeAccepted', null) +if ( ! (get_doku_pref('cookieNoticeAccepted', null) 
-       || get_doku_pref('cookieNoticeAccepted', '')) ) { +     || get_doku_pref('cookieNoticeAccepted', '')) ) { 
-    // Your PHP code +  // Your PHP code (eg. in 3th-party plugin) 
-  +
-</code>+</file> 
  
 ==== Google Analytics ==== ==== Google Analytics ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''useGoogleAnalytics'' | Enable Google Analytics | ''0''+| ''useGoogleAnalytics'' | Enable Google Analytics | onoff | ''0'' |  
-| ''googleAnalyticsTrackID'' | Tracking ID | ''null''+| ''googleAnalyticsTrackID'' | Tracking ID | string | ''null'' |  
-| ''googleAnalyticsAnonymizeIP'' | Anonymize the IP address of visitors | ''0''+| ''googleAnalyticsAnonymizeIP'' | Anonymize the IP address of visitors | onoff | ''0'' |  
-| ''googleAnalyticsNoTrackAdmin'' | Disable tracking for the Admin users | ''1''+| ''googleAnalyticsNoTrackAdmin'' | Disable tracking for the Admin users | onoff | ''1'' |  
-| ''googleAnalyticsNoTrackUsers'' | Disable tracking for all logged users | ''0''+| ''googleAnalyticsNoTrackUsers'' | Disable tracking for all logged users | onoff | ''0'' |  
-| ''googleAnalyticsNoTrackPages'' | Disable tracking for specified pages (insert a regex) | ''null''+| ''googleAnalyticsNoTrackPages'' | Disable tracking for specified pages (insert a regex) | regex | ''null'' |  
-| ''googleAnalyticsTrackActions'' | Track DokuWiki actions (edit, search, etc) | ''0'' |+| ''googleAnalyticsTrackActions'' | Track DokuWiki actions (edit, search, etc) | onoff | ''0'' |  |
  
  
 ==== Browser Title ==== ==== Browser Title ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''browserTitle'' | DokuWiki browser title (default is ''@[email protected] [@[email protected]]'', where ''@[email protected]'' placeholder replace the current page title and ''@[email protected]'' replace the DokuWiki name) - see [[config:title|title]] config | ''@[email protected] [@[email protected]]''+| ''browserTitle'' | DokuWiki browser title (default is ''@[email protected] [@[email protected]]'', where ''@[email protected]'' placeholder replace the current page title and ''@[email protected]'' replace the DokuWiki name) - see [[config:title|title]] config | string | ''@[email protected] [@[email protected]]'' |  
-| ''browserTitleShowNS'' | Display the previous page name of current page on the browser title | ''0''+| ''browserTitleShowNS'' | Display the previous page name of current page on the browser title | onoff | ''0'' |  
-| ''browserTitleCharSepNS'' | Character separator for every namespaces on browser title | ''-''+| ''browserTitleCharSepNS'' | Character separator for every namespaces on browser title | multichoice | ''-'' | ''-'' \\ ''|'' \\ '','' \\ ''/'' \\ ''>''
-| ''browserTitleOrderNS'' | Set the order of namespaces | ''normal'' |+| ''browserTitleOrderNS'' | Set the order of namespaces | multichoice | ''normal'' | ''normal'' \\ ''reverse'' |
  
  
 ==== Page ==== ==== Page ====
  
-^ Option ^ Description ^ Default Value ^ +^ Option ^ Description ^ Value Type ^ Default Value 
-| ''showPageInfo'' | Show page info (e.g., date, author) | ''1''+| ''showPageInfo'' | Show page info (e.g., date, author) | onoff | ''1'' |  | 
-| ''pageInfo'' | Display/Hide page info elements | ''filename,extension,date,editor,locked''+| ''useACL'' | Use ACL for sidebars (left and right) and for all DokuWiki hooks (eg. '':footer'', '':navbar'', etc.)  \\  **NOTE:** Available since "Elenor of Tsort" DokuWiki release | onoff | ''0'' |  | 
-| ''pageInfoDateFormat'' | Date format | ''dformat''+| ''showPurgePageCache'' | Display the "Purge Cache Page" button in Page Tools | multichoice | ''never'' | ''never'' \\ ''logged'' \\ ''always''
-| ''showPageIcons'' | Display useful icons (print, share link, send mail, etc.) on page | ''0''+| ''pageInfo'' | Display/Hide page info elements | multicheckbox | ''filename,extension,date,editor,locked'' | ''filename'' \\ ''extension'' \\ ''date'' \\ ''editor'' \\ ''locked''
-| ''pageIcons'' | Select the icons to display | ''social-share,feed,send-mail,print,help''+| ''pageInfoDateFormat'' | Date format | multichoice | ''dformat'' | ''dformat'' \\ ''human''
-| ''socialShareProviders'' | Select the social share links to display | ''facebook,google-plus,linkedin,pinterest,whatsapp,twitter''+| ''showPageIcons'' | Display useful icons (print, share link, send mail, etc.) on page | onoff | ''0'' |  
-| ''tagsOnTop'' | Move all Tags on top of the page, beside the page-id (require //Tag Plugin//) | ''1''+| ''pageIcons'' | Select the icons to display | multicheckbox | ''social-share,feed,send-mail,permalink,print,help'' | ''social-share'' \\ ''feed'' \\ ''send-mail'' \\ ''permalink'' \\ ''print'' \\ ''help''
-| ''useAnchorJS'' | Use AnchorJS | ''1'' |+| ''socialShareProviders'' | Select the social share links to display | multicheckbox | ''facebook,google-plus,linkedin,pinterest,whatsapp,twitter,telegram'' | ''facebook'' \\ ''google-plus'' \\ ''linkedin'' \\ ''pinterest'' \\ ''whatsapp'' \\ ''twitter'' \\ ''telegram''
 +| ''tagsOnTop'' | Move all Tags on top of the page, beside the page-id (require //Tag Plugin//| onoff | ''1'' |  
 +| ''useAnchorJS'' | Use AnchorJS | onoff | ''1'' |  | 
 +| ''collapsibleSections'' | Collapse 2nd section level (useful in mobile/tablet devices) | onoff | ''0'' |  | 
 +| ''domParserMaxPageSize'' | Set the max size of the page content for DOM Parser. The optimal and default value is ''600000'' (600KB) | numeric | ''600000'' |  | 
 + 
 + 
 +==== Deprecated configurations ==== 
 + 
 +^ Option ^ Description ^ 
 +| ''useLegacyNavbar'' | Use '':navbar'' DokuWiki hook page (see [[#dokuwiki_hooks|DokuWiki hooks]] paragraph) | 
 +| ''useGravatar'' | Replaced by ''useAvatar'' configuration |
  
  • wiki/template/bootstrap3/config.1460581168.txt.gz
  • Last modified: 6 years ago
  • by Giuseppe Di Terlizzi