{{ :en:blog:projects:themes:dokuwiki:logo-writr.png?nolink&400 |}}
====== Writr ======
This template was converted from the [[https://wordpress.org/themes/writr/|WordPress theme Writr]]. It was voted for by DokuWiki users from a selection of 19 other WordPress themes to convert.

^ Description | Bold, minimalist and modern |
^ Author | Louis Ouellet, Anika Henke |
^ Email | louis@laswitchtech.com |
^ Last Update | 2024-01-02 |
^ Compatible | Jack Jackrum |
^ Download | [[https://github.com/LouisOuellet/dokuwiki_template_writr/archive/refs/heads/master.zip| Download]] |
^ Bug Tracker | [[https://github.com/LouisOuellet/dokuwiki_template_writr/issues| Issues]] |
^ Source | [[https://github.com/LouisOuellet/dokuwiki_template_writr| Source]] |
^ Donation | [[https://www.paypal.com/donate/?business=8G9UN4VH4AE38&no_recurring=0&item_name=Become+a+sustaining+member+of+our+charitable+community.&currency_code=CAD | Donation]] |

===== Download and Install ======
Search and install the template using the [[https://www.dokuwiki.org/plugin:extension|Extension Manager]]. Refer to [[https://www.dokuwiki.org/template | Template]] on how to install a template manually.

===== Features =====
  * Improve the general aesthetic for a more modern look and consistency
  * Personalize using template's configurations and template's style configrations
  * Support for Bootstrap Icons
  * Support for many DokuWiki Plugins (See list below)
  * A new toolbar is now available in the template configuration. Based on the original WordPress Theme Writr.
    * A new hook ''topbar'' is available to add content to the toolbar. Using the same formatting as ''topnav''.
  * A new set of tooltips is now available in the template configuration.
    * If toggled, the template will replace the browser's tooltips for these new ones
  * Hide/Show Site-Tools based on user login. (CMS mode)
  * Set Logo per namespace
    * If toggled, the template will look for the nearest logo.png file it can find.
  * Set Logo's link per namespace
    * If toggled, the template will use the logo's namespace as the link
  * Set Site Title per namespace
    * If toggled, the template will use the ''nstitle'' hook to retrieve the title of the site. If none can be found then the dokuwiki title is used.
  * Set Site Tagline per namespace
    * If toggled, the template will use the ''nstagline'' hook to retrieve the tagline of the site. If none can be found then the dokuwiki tagline is used.

===== Screenshots =====
{{gallery>:en:blog:projects:themes:dokuwiki:writr:screenshots}}

===== Sites using this template ======
  * [[https://laswitchtech.com/ | LaswitchTech]]
  * [[https://www.dkriesel.com/ | D. Kriesel]]
  * [[https://nl.offipedia.org/ | Offipedia]]
  * [[https://brasiliaminha.com.br/ | Brasília Minha]]
  * [[http://axamonitor.com/ | AxaMonitor]] --- FIXME No SSL
  * [[https://docs.fblf.fr/|DOCUMENTATION FBLF]]

===== Documentations =====
==== Plugins ====
^ Plugin ^ Tested ^ Themed ^ Comments ^
| [[https://www.dokuwiki.org/plugin:accscounter|Access Counter and Popularity Plugin]] | {{icon>xmark}} | {{icon>xmark}} | Not yet fully supported. Seems like there is a lot to do on this plugin |
| [[https://www.dokuwiki.org/plugin:acl|ACL Manager]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:addnewpage|Add New Page]] | {{icon>check}} | {{icon>check}} | Styled and added into the page tools |
| [[https://www.dokuwiki.org/plugin:advanced|Advanced DokuWiki]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:authplain|Plain Auth]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:avatar|Avatar]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:blockquote|Blockquote]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:blog|Blog]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:bloglinks|Bloglinks]] | {{icon>check}} | {{icon>check}} | Read below for more details and customizations of the links |
| [[https://www.dokuwiki.org/plugin:bureaucracy|Bureaucracy]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:captcha|Captcha]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:cloud|Cloud]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:commentsyntax|Comment Syntax support]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:config|Configuration Manager]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:data|Structured Data]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:denyactions|denyactions]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:diagrams|Diagrams]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:discussion|Discussion]] | {{icon>check}} | {{icon>check}} | Styled using the WordPress Theme Writr as reference |
| [[https://www.dokuwiki.org/plugin:dw2pdf|DW2pdf]] | {{icon>check}} | {{icon>check}} | Set a more proper icon within the page tool |
| [[https://www.dokuwiki.org/plugin:extension|Extension Manager]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:folded|folded]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:dokuwiki-plugin-fontawesome|fontawesome]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:gallery|Gallery]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:gh|GH]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:hidepages|Hidepages]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:icons|Icons]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:include|Include]] | {{icon>check}} | {{icon>check}} | Read below for more details and customizations of the links |
| [[https://www.dokuwiki.org/plugin:info|Info]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:indexmenu|Indexmenu]] | {{icon>check}} | {{icon>check}} | Styled for the topnav page |
| [[https://www.dokuwiki.org/plugin:keyboard|Keyboard]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:linkback|Linkback]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:logviewer|LogViewer]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:move|Move]] | {{icon>check}} | {{icon>xmark}} | Some maintenance is required by the plugin author to fully support PHP8. You may see some PHP Warning if your server is configured to show them. |
| [[https://www.dokuwiki.org/plugin:nspage|nspage]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:pagelist|Pagelist]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:prosemirror| Prosemirror]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:revert|Revert Manager]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:safefnrecode |safefnrecode]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:searchform|Search Form]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:socialite|Socialite]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:sqlite|sqlite]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:styling|styling]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:svgembed|svgEmbed]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:tag|Tag]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:tagsections|tagsections]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:translation|Translation]] | {{icon>check}} | {{icon>check}} | Styled and added into the page tools |
| [[https://www.dokuwiki.org/plugin:typography|Typography]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:upgrade|Upgrade]] | {{icon>check}} | {{icon>check}} | |
| [[https://www.dokuwiki.org/plugin:userhistory|User History Manager]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:usermanager|User Manager]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:userpagecreate|userpagecreate]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:vshare|Video Sharing Site]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:wrap|Wrap]] | {{icon>check}} | {{icon>xmark}} | |
| [[https://www.dokuwiki.org/plugin:yourip|yourip]] | {{icon>check}} | {{icon>xmark}} | |

==== Page Tools ====
^ Button ^ Function ^
| {{:en:blog:projects:themes:dokuwiki:writr:page-tools:pt-addnewpage.png?nolink||}} | AddNewPage Plugin |
| {{:en:blog:projects:themes:dokuwiki:writr:page-tools:pt-backlinks.png?nolink|}} | Built-in Backlinks |
| {{:en:blog:projects:themes:dokuwiki:writr:page-tools:pt-backtotop.png?nolink|}} | Built-in Back to Top |
| {{:en:blog:projects:themes:dokuwiki:writr:page-tools:pt-dw2pdf.png?nolink|}} | DW2PDF Plugin |
| {{:en:blog:projects:themes:dokuwiki:writr:page-tools:pt-edit.png?nolink|}} | Built-in Edit |
| {{:en:blog:projects:themes:dokuwiki:writr:page-tools:pt-revisions.png?nolink|}} | Built-in Revisions |
| {{:en:blog:projects:themes:dokuwiki:writr:page-tools:pt-subscriptions.png?nolink|}} | Built-in Subscriptions |
| {{:en:blog:projects:themes:dokuwiki:writr:page-tools:pt-translation.png?nolink|}} | Translation Plugin |

==== Configuration ====
  * Show the title of the page tools
  * Show the title of the site tools
  * Show the title of the user tools
  * Should the site tools require login
  * Should the logo changes be by namespace

==== Plugins ====
=== Bloglinks ===
For best results, update your configurations with the following:
  * plugin»bloglinks»prev_template = ''%%<span class="icon">%%%%</span>%%%%<span class="title">%%@@TITLE@@%%</span>%%''
  * plugin»bloglinks»next_template = ''%%<span class="title">%%@@TITLE@@%%</span>%%%%<span class="icon">%%%%</span>%%''
Additionally, you may add the class ''truncate'' to the ''<span class="title truncate">'' to truncate the page title. This will truncate the title to a single line that fits within the ''prev'' and ''next'' buttons.

=== Include ===
For best results, add the following configuration files:
**''[WEBROOT]/conf/plugin_lang/include/en/lang.php''**
<code php>
<?php
/**
 *
 * English language file
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 *
 */
$lang['readmore']              = 'Read more';
</code>
**''[WEBROOT]/conf/plugin_lang/include/fr/lang.php''**
<code php>
<?php
/**
 *
 * French language file
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 *
 */
$lang['readmore']              = 'Lire la suite';
</code>

==== Customization ====
=== Logo ===
You can change the logo, favicon and apple touch icon the [[https://www.dokuwiki.org/template:dokuwiki#changing_the_logo|same way as for the dokuwiki template]].

== Namespace Logo ==
Namespace Logos can be added using the media library. To show a different logo in a namespace, just make sure to add the custom ''logo.png'' in the namespace. This feature is recursive.

=== Navigation ===
This templates supports multiple levels of a navigation. For that to work you need to add a page called ''topnav'' and add a list of links to it. (No other content is supported.)
The example in the screenshot uses this as the content for the topnav page:

<code>
  * [[:start|Home]]
  * [[wiki:DokuWiki]]
    * [[wiki:Syntax]]
  * [[:Sample Page]]

~~NOCACHE~~
</code>

=== Other sidebar content ===
The content of a standard sidebar as configured in [[https://www.dokuwiki.org/config:sidebar|Configuration Setting: sidebar]] will be added between the navigation and the tools list.

== Note ==
I haven't tested a sidebar yet since the last various updates I made. I will check it out soon.

=== Include hooks ===
Include hooks allow you to add additional HTML or PHP to the template without modifying any of the template files themselves. This template supports the [[https://www.dokuwiki.org/template:dokuwiki#supported_include_hooks|same include hooks as the dokuwiki template]].

=== Colour Schemes ===
The original WordPress theme came with 6 different colour schemes. Those can easily be achieved by changing the ''%%__theme_color__%%'' and ''%%__theme_color_alt__%%'' values in your local ''[[https://www.dokuwiki.org/devel:style.ini#local_styleini|style.ini]]'' to the following:

^Colour scheme ^theme_color ^ theme_color_alt ^
|turquois      |''#1abc9c'' |''#16a085''      |
|red           |''#e74c3c'' |''#c0392b''      |
|purple        |''#a162ba'' |''#8e44ad''      |
|grey          |''#95a5a6'' |''#7f8c8d''      |
|green         |''#2ecc71'' |''#27ae60''      |
|blue          |''#3498db'' |''#2980b9''      |

This should actually be done in the [[https://www.dokuwiki.org/plugin:styling|styling plugin]] over the admin interface. No need to go out of your way to edit style.ini.
== Note ==
I will be moving this to themes and setup a custom theme so users can set these colors and other css properties not currently supported by the [[https://www.dokuwiki.org/plugin:styling|styling plugin]].

=== Content width ===
The width of the content area can be adjusted with the ''%%__content_width__%%'' variable in the style.ini. Since DokuWiki version 2015-08-10 “Detritus” you can do that more easily with the [[https://www.dokuwiki.org/plugin:styling|styling plugin]] over the admin interface.

This is currently limited to px size. Will try to add a full-width option for the template.

===== Development =====
==== Changelog ====
{{rss>https://github.com/LouisOuellet/dokuwiki_template_writr/commits/master.atom 20 date}}

==== Planning ====
  * Add more fonts (suggestions?)
  * Add option to make the content full width
  * Add support for Starred Plugin
  * Work on the Media Library CSS to make it more consistent
  * Add toggle-able sidebar
  * Review existing issues
  * Investigate an issue with the Struct Plugin
  * Revise mobile styling
  * Revise responsive styling

===== Tags =====
{{tag>"sidebar" "responsive" "bold" "modern" "minimal" "navigation" "wordpress" "bootstrap" "writr"}}

~~socialite:icon twitter facebook linkedin reddit telegram  email ~~
~~LINKBACK~~
~~DISCUSSION~~