====== Admin ======

===== Wiki Tools =====
 
  * [[/home?do=media |media manager]]
  * [[/home?do=admin&page=move_tree |move tree]]
  * [[/home?do=admin&page=confmanager |configuration file manager]]

===== Upgrating the Wiki Engine =====
When upgrading the core wiki engine, follow these steps:
  - [[?do=admin&page=extension |Update all plugins]] **before** updating the wiki itself
  - Install the [[https://www.dokuwiki.org/plugin:htmlok |htmlok plugin]] 
  - Install the [[https://www.dokuwiki.org/plugin:searchindex |SearchIndex plugin]].  You'll need to "Rebuild Index" **after** the wiki is updated.
  - [[?do=admin&page=upgrade |Upgrade the Wiki]]
  - Enable the htmlok plugin in the [[?do=admin&page=config#plugin____confightmlok____plugin_settings_name|config manager]]
  - [[?do=admin&page=searchindex |Rebuild Index]]
  - Follow the steps below to re-modify the template.

===== Template Mods =====
==== Collapse TOC automatically ====
  * open <code bash>
pico lib/tpl/dokuwiki/script.js
</code>

  * find <code javascript>
if($toc.length) {
  $toc[0].setState(1);
</code>

  * replace with <code javascript>
if($toc.length) {
  $toc[0].setState(-1);
</code>


==== Browser <head> ====

Changed ''lib/tpl/dokuwiki/main.php''

from:
<file php>
<title><?php tpl_pagetitle() ?> [<?php echo strip_tags($conf['title'])</title>
</file>

to:
<file php>
<title>West Coast AREDN</title>
</file>


==== Top Bar ====

  * Added this file <code php lib/tpl/dokuwiki/topbar.html>
<div class="topbar">
    <?php tpl_include_page('topbar') /* includes the wiki page "topbar" */ ?>
</div>
</code>
  * Added this line of code at the end of <code php lib/tpl/dokuwiki/tpl_header.php>
<?php tpl_includeFile('topbar.html') ?>
</code>
  * Add links as ''tabs'' using the WRAP plugins in [[/topbar]]


==== Footer ====
  * Removed extra buttons in footer by removing these lines <file php lib/tpl/dokuwiki/tpl_footer.php>
<a href="https://www.dokuwiki.org/donate" title="Donate" <?php echo $target?>><img
    src="<?php echo tpl_basedir(); ?>images/button-donate.gif" width="80" height="15" alt="Donate" /></a>
<a href="https://php.net" title="Powered by PHP" <?php echo $target?>><img
    src="<?php echo tpl_basedir(); ?>images/button-php.gif" width="80" height="15" alt="Powered by PHP" /></a>
<a href="//validator.w3.org/check/referer" title="Valid HTML5" <?php echo $target?>><img
    src="<?php echo tpl_basedir(); ?>images/button-html5.png" width="80" height="15" alt="Valid HTML5" /></a>
<a href="//jigsaw.w3.org/css-validator/check/referer?profile=css3" title="Valid CSS" <?php echo $target?>><img
    src="<?php echo tpl_basedir(); ?>images/button-css.png" width="80" height="15" alt="Valid CSS" /></a>
<a href="https://dokuwiki.org/" title="Driven by DokuWiki" <?php echo $target?>><img
    src="<?php echo tpl_basedir(); ?>images/button-dw.png" width="80" height="15"
    alt="Driven by DokuWiki" /></a>
</file>

  * and also remove the second to last line: ''    <?php tpl_includeFile('footer.html'); ?>''

=== For Static Site Only ===

Changes to [[aredn>http://va7fi-linux.local.mesh/wiki]] (only):

  * Created a [[aredn>http://va7fi-linux.local.mesh/wiki/footer |footer]] page on the AREDN site (only) that will be automatically updated by the sync script.

  * Created this file:<file html lib/tpl/dokuwiki/footer.html>
<div class="footer">
    <?php tpl_include_page('footer') /* includes the wiki page "footer" */ ?>
</div>
</file>

  * Around line 955, added a line commented some lines out to remove ''[page] Last Modified: [date] by [user]'' in the footer. <wrap warning>Be careful not to add extra lines at the top or none of the pictures will show</wrap><file php inc/template.php [highlight_lines_extra="2,4,16"]>
    // print it
    $out=tpl_includeFile('footer.html');
    if ($INFO['exists']) {
/*
        $out = '<bdi>' . $fn . '</bdi>';
        $out .= ' · ';
        $out .= $lang['lastmod'];
        $out .= ' ';
        $out .= $date;
        if ($INFO['editor']) {
            $out .= ' ' . $lang['by'] . ' ';
            $out .= '<bdi>' . editorinfo($INFO['editor']) . '</bdi>';
        } else {
            $out .= ' (' . $lang['external_edit'] . ')';
        }
*/
</file>

==== Header Spacing ====

  * Edited this file: <file css lib/tpl/dokuwiki/css/design.less [highlight_lines_extra="2,6,7"]>
#dokuwiki__header {
    padding: 2em 0 0;       // padding (top, left, bottom) of logo 

    .headings,
    .tools {
        margin-top: 0em;        // padding at the top of the logo and title
        margin-bottom: 0em;     // padding at the bottom of the logo and title
        width: 49%;             // width of logo
    }
    .tools {
        margin-top: .2em;      // padding between first line and search bar
    }

    h1 {
        margin: 0em;             // top-left corner margin of logo and title
        margin-top: 0em;         // padding above logo and title
        margin-bottom: 2em;      // padding below logo and title
        font-size: 1.5em;
        font-weight: normal;

        img {			//postion of logo only
            float: left;
            margin-right: .5em;
            margin-top: 0em;
        }
</file>

==== Editing Window Message ====
Edited the following file to:
<file doku inc/lang/en/edit.txt>
Edit the page (only if you can **improve** it) and hit ''Save''.
For help, see the [[/wikisyntax/home|Syntax page]].
If you want to test some things, use the
[[/wikisyntax/playground|Playground page]].
</file>


==== AREDN links ====
Created an AREDN link type with a different icons to show which links require connection to AREDN.  The syntax is:
<code>
[[aredn>link]]
</code>

Created this file:
<file bash conf/interwiki.local.conf>
aredn     {NAME}
</file>

And copied the favicon.ico to a different folder as a different name:
<code>
cp ./data/media/favicon.ico ./lib/images/interwiki/aredn.svg
</code>

==== Troubleshooting ====
=== Broken Images ===

If after tweaking the template files the images don't show anymore, it might be that there are extra lines or spaces on some of the php files.
  * Copy [[https://www.dokuwiki.org/tips:findbadphp.php|this script]] to the /wiki/ folder and fix its permissions.
  * Call the script from the browser.  It'll produce a list of php files that have issues.
  * Manually fix each file.



===== Update Script =====

This Bash script runs at least once a day at 2am to synchronize the [[aredn>http://va7fi-linux.local.mesh/wiki |Mesh site]] from the [[https://wcaredn.ca |Public site]]:((Must be run as root))
<file bash AREDNSync.sh>
#!/bin/bash

# Navigate to wiki data pages
cd /var/www/html/wiki/data/pages/

# Sync the text pages that have changed from server, excluding the about page
# (which are different), and the footer page.
rsync -apP -e ssh --delete --exclude 'about/home.txt' --exclude 'footer.txt' \
  --exclude 'nextcloud/login.txt' \
  patrick@scarcs.ca:~/sites/aredn/data/pages/ /var/www/html/wiki/data/pages/


# Sync the media files that have changed from server.
rsync -apP -e ssh --delete patrick@scarcs.ca:~/sites/aredn/data/media/ \
   /var/www/html/wiki/data/media/


# Write custom footer page to note the date of last sync.
echo '<WRAP rightalign><fs x-small>Last synchronized from [[https://wcaredn.ca]] on' \
  $(date) '</fs></WRAP>' > footer.txt

# Update ownership and permissions that might have been lost during the sync
chown aredn:www-data -R /var/www/html/wiki/data/
chmod 770 -R /var/www/html/wiki/data/

# Refresh the cache to make the changes visible.
touch /home/aredn/html/wiki/conf/local.php

</file>

To add cronjob, add:
<code bash>
0 2 * * * . /home/aredn/Scripts/SyncWiki.sh
</code>