Bootstrap3 Template

Configurations

The template can be widely configured via the Configuration Manager or manually edit the <dokuwiki>/conf/local.php file, including a line like:

$conf['tpl']['bootstrap3']['fluidContainerBtn'] = '1';

(This adds a button to turn on / off fluid layout. See the fluidContainerBtn option below.)

Theme

Option Description Value Type Default Value
bootstrapTheme Bootstrap theme multichoice default default
optional
custom
bootswatch
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 string null
showThemeSwitcher Show Bootswatch.com theme switcher in navbar onoff 0
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 onoff 1
themeByNamespace Use a namespaced theme onoff 0
Option Description Value Type Default Value
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 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
string rightsidebar
leftSidebarGrid Left sidebar grid classes col-{xs,sm,md,lg}-x (see Bootstrap Grids documentation) string col-sm-3 col-md-2
rightSidebarGrid Right sidebar grid classes col-{xs,sm,md,lg}-x (see 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
Option Description Value Type Default Value
inverseNavbar Inverse navbar onoff 0
fixedTopNavbar Fix navbar to top onoff 0
showTranslation Display translation toolbar (require Translation Plugin) onoff 0
showTools Display Tools in navbar multichoice always never
logged
always
showHomePageLink Display Home-Page link in navbar onoff 0
homePageURL Use custom URL for home-page links string null
showUserHomeLink Display User Home-Page link in navbar onoff 1
hideLoginLink Hide the login button in navbar. This option is useful in “read-only” DokuWiki installations (eg. blog, personal website) onoff 0
showEditBtn Display edit button in navbar multichoice never never
logged
always
individualTools Split the Tools in individual menu in navbar onoff 0
showIndividualTool Enable/Disable individual tool in navbar multicheckbox site,page user
site
page
showSearchForm Display Search form in navbar multichoice always never
logged
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

Adds Schema.org markup to enable basic support for semantic data. For full support use the semantic plugin.

Option Description Value Type Default Value
semantic Enable semantic data onoff 1
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

Option Description Value Type Default Value
fluidContainer Enable the fluid container (full-width of page) onoff 0
fluidContainerBtn Display a button in navbar to expand container onoff 0
pageOnPanel Enable the panel around the page onoff 1
tableFullWidth Enable 100% full table width (Bootstrap default) onoff 1
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) onoff 0
landingPages Landing page name (insert a regex) regex (intro)
showPageTools Enable the DokuWiki-style Page Tools multichoice always never
logged
always
pageToolsAnimation Enable the Page Tools animation onoff 1
showPageId Display the DokuWiki page name (pageId) on top onoff 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 onoff 0
showWikiInfo Display DokuWiki name, logo and tagline on footer onoff 1

TOC

Option Description Value Type Default Value
tocAffix Affix the TOC during page scrolling onoff 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

Option Description Value Type Default Value
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 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

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).

Option Description Value Type Default Value
showCookieLawBanner Display the Cookie Law banner on footer onoff 0
cookieLawBannerPage Cookie Law banner page name string cookie:banner
cookieLawPolicyPage Cookie Law policy page name string cookie: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:

if (DokuCookie.getValue('cookieNoticeAccepted')) {
  // Your JS code (eg. in userscript.js or in 3th-party plugin)
}

PHP Snippet:

if ( ! (get_doku_pref('cookieNoticeAccepted', null)
     || get_doku_pref('cookieNoticeAccepted', '')) ) {
  // Your PHP code (eg. in 3th-party plugin)
}

Google Analytics

Option Description Value Type Default Value
useGoogleAnalytics Enable Google Analytics onoff 0
googleAnalyticsTrackID Tracking ID string null
googleAnalyticsAnonymizeIP Anonymize the IP address of visitors onoff 0
googleAnalyticsNoTrackAdmin Disable tracking for the Admin users onoff 1
googleAnalyticsNoTrackUsers Disable tracking for all logged users onoff 0
googleAnalyticsNoTrackPages Disable tracking for specified pages (insert a regex) regex null
googleAnalyticsTrackActions Track DokuWiki actions (edit, search, etc) onoff 0

Browser Title

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 title config string @[email protected] [@[email protected]]
browserTitleShowNS Display the previous page name of current page on the browser title onoff 0
browserTitleCharSepNS Character separator for every namespaces on browser title multichoice - -
|
,
/
>
browserTitleOrderNS Set the order of namespaces multichoice normal normal
reverse

Page

Option Description Value Type Default Value
showPageInfo Show page info (e.g., date, author) onoff 1
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
showPurgePageCache Display the “Purge Cache Page” button in Page Tools multichoice never never
logged
always
pageInfo Display/Hide page info elements multicheckbox filename,extension,date,editor,locked filename
extension
date
editor
locked
pageInfoDateFormat Date format multichoice dformat dformat
human
showPageIcons Display useful icons (print, share link, send mail, etc.) on page onoff 0
pageIcons Select the icons to display multicheckbox social-share,feed,send-mail,permalink,print,help social-share
feed
send-mail
permalink
print
help
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 paragraph)
useGravatar Replaced by useAvatar configuration
  • wiki/template/bootstrap3/config.txt
  • Last modified: 10 months ago
  • by Giuseppe Di Terlizzi