DokuWiki

It's better when it's simple

User Tools

Site Tools


template:bootstrap3:hooks

Differences

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

Link to this comparison view

template:bootstrap3:hooks [2019-03-15 22:53] (current)
lotar created
Line 1: Line 1:
 +<= [[template:​bootstrap3|Bootstrap3 Template]]
 +
 +====== Bootstrap3: Hooks ======
 +
 +==== HTML Hooks ====
 +
 +All files must be located in the template directory (''​lib/​tpl/​bootstrap3/''​) or your ''​conf/''​ directory (upgrade-safe).
 +
 +^ File Name           ^ Position of included HTML ^
 +^ ''​meta.html'' ​      | Inside the HTML ''<​head>'',​ use this to add additional styles or metaheaders |
 +^ ''​topheader.html'' ​ | At the very top of the page right after the ''<​body>''​ tag |
 +^ ''​header.html'' ​    | Above the upper blue bar, below the pagename and wiki title |
 +^ ''​navbar.html'' ​    | **DEPRECATED** (see the note below) - Inside the navbar, use this to add additional links (e.g. ''<​li><​a href="/​foo">​Foo</​a></​li>''​) |
 +^ ''​pageheader.html''​ | Below the breadcrumbs,​ above the actual content |
 +^ ''​pagefooter.html''​ | Above the lower blue bar, below the last changed Date |
 +^ ''​footer.html'' ​    | At the very end of the page just before the ''</​body>''​ tag |
 +^ ''​sidebarheader.html''​ | On top of the sidebar |
 +^ ''​sidebarfooter.html''​ | On bottom of the sidebar |
 +^ ''​social.html'' ​       | Below the ''​header.html'',​ use this to add a social buttons (eg. Google+, Twitter, LinkedIn, etc) |
 +^ ''​rightsidebarheader.html''​ | On top of the right sidebar |
 +^ ''​rightsidebarfooter.html''​ | On bottom of the right sidebar |
 +
 +:!: ** NOTE for navbar.html **
 +
 +This [[https://​github.com/​LotarProject/​dokuwiki-template-bootstrap3/​commit/​c10c0488c2581f8c6e04320c2716edf301f046f9|c10c048 commit]] introduced a new navbar hook ('':​navbar''​). Please use this new hook, because the ''​navbar.html''​ is deprecated and will be removed in the future release of template.
 +
 +If you want to add only the Home-Page link, set the ''​showHomePageLink''​.
 +
 +==== DokuWiki hooks ====
 +
 +You can customize various parts of your page by creating simple DokuWiki "​hook"​ pages. The bootstrap3 template will plug these page snippets contained in each of these custom pages into the overall layout of the page.
 +
 +^ Page name          ^ Description ^ Per namespaces ^
 +| '':​sidebar'' ​      | The sidebar | YES |
 +| '':​rightsidebar'' ​ | The right-sidebar | YES |
 +| '':​navbar'' ​       | Navbar with sub-menus | YES |
 +| '':​pageheader'' ​   | Header of the Wiki article | YES |
 +| '':​pagefooter'' ​   | Footer of the Wiki article | YES |
 +| '':​footer'' ​       | Footer of the page | YES |
 +| '':​cookie:​banner''​ | Cookie-Law banner | NO |
 +| '':​cookie:​policy''​ | Cookie-Law policy | NO |
 +| '':​help'' ​         | Help page for "Help Page Icon" | YES |
 +| '':​header'' ​       | Header of page below the navbar | YES |
 +| '':​topheader'' ​    | Top Header of page (on top of navbar if ''​fixedTopNavbar''​ is **off**) | YES |
 +
 +
 +=== Navbar ===
 +
 +This "​hook"​ page is a standard DokuWiki page with an unordered-list of links (internal or external). The templating engine replaces the unordered-list with a menu bar with a dropdown-menu.
 +
 +This is an example:
 +
 +{{ http://​lotar.altervista.org/​dokuwiki/​_media/​wiki/​template/​bootstrap3-template-navbar-page.png?​nocache|}} <​code>​
 +  * [[:​start|Home]]
 +  * DokuWiki
 +    * [[:​wiki:​welcome]]
 +    * [[:​wiki:​syntax]]
 +    * [[:​wiki:​dokuwiki]]
 +  * [[:​playground:​playground]]
 +~~NOCACHE~~
 +</​code>​
 +
 +
 +:!: It is possible to create different navbars for every namespaces with the same behavior of sidebar page.
  
template/bootstrap3/hooks.txt ยท Last modified: 2019-03-15 22:53 by lotar