====== amanuensis Template ======

---- template ----
description   : Template with dropdown menus, valid pagelink insertions, etc.
author        : Green Box
email         : greenboxster@gmail.com
lastupdate    : 2005-11-30
compatible    : 
depends       : 
conflicts     : 
similar       : 
tags          : 

downloadurl   : https://trello.com/1/cards/5d600d527edb404fd42f813d/attachments/5d600d6f491c4749eb7db097/download/amanuensis.zip
bugtracker    : 
sourcerepo    : 
donationurl   : 

screenshot_img: 
----

This template is intended to make DokuWiki a little easier to use for non technical users by:

  - Providing a dropdown index, showing pages organized by namespace
  - Add an easy means of inserting links to valid pages
  - Replace namespace/page construct with one of pages and subpages
  - Add a form to directly add new pages (and subpages)
  - Keep it clean, keep it wiki

===== Download and Install ======

Use the following URL to download this template:

  * [[https://trello.com/1/cards/5d600d527edb404fd42f813d/attachments/5d600d6f491c4749eb7db097/download/amanuensis.zip|amanuensis.zip]]

Refer to [[:template]] on how to install and use templates in DokuWiki. Then follow these steps:

  - Copy ''about.txt'' and ''help.txt'' from the root of the templates directory to ''/data/wiki''
  - Add the following lines to **/conf/local.php** <code php>$conf['amanuensis']['nspages'] = 'true';</code> and <code php>$conf['amanuensis']['addpage'] = 'true';</code>
  - Replace the logo ''/lib/tpl/amanuensis/images/logo/amanuensis.png'' with one of your choosing
  - Do the following modifications

==== To show pages describing namespaces: ====

**Note:** The following modification will **break the index** (and it will not appear as an option). Because the index functionality is largely provided by the dropdowns, this may not be a problem.

In ''/conf/local.php'' set

  $conf['amanuensis']['nspages'] = 'true';

This setting can be set to 'false' to disable this behavior (and re-enable the index) after the following mod has been added.

And in ''/doku.php'' add the following after line #41

<code php>
    //!! ADDED FOR 'AMANUENSIS' TEMPLATE TO SHOW NAMESPACE PAGES !!
    if  ($conf['amanuensis']['nspages'] == 'true'){
      $conf['amanuensis']['dokunsmod'] = true;    //flags that mod has been added
        if (!empty($IDX)){
           $ID=$IDX;
          $IDX=NULL;
         $ACT='show';
      }
    }
    //!! END ADDED TO SHOW NAMESPACE PAGES !!
</code>

==== To provide form to add page and subpage: ====

In ''/conf/local.php'' set 

  $conf['amanuensis']['addpage'] = 'true';

And in ''/doku.php'' add the following after line #41 (or after the modification above)

<code php>
    //!! ADDED FOR 'AMANUENSIS' TEMPLATE TO SHOW ADDPAGE FORM!!
    if  ($conf['amanuensis']['addpage']=='true'){
    $conf['amanuensis']['addpagemod'] = true;    //flags that mod has been added
    if($ACT == 'addpage'){
      if ($_REQUEST['newpagename']){
        if ($_REQUEST['addpage']=='SubPage'){
          $ID.=':'.$_REQUEST['newpagename'];
          $IDX = NULL;
        }
        if ($_REQUEST ['addpage']=='Page'){
          $ID=getNS($ID).':'.$_REQUEST['newpagename'];
          $IDX=NULL;
        }
      }
     $ACT = 'show';
    }
    }
    //!! ADDED FOR ADDPAGE !!
</code>


===== Operation =====

Hovering over the page name will produce a dropdown menu, showing pages and their subpages. Hovering over sections of the name will show only those pages beneath that level. Clicking on a pagename will navigate to that page. ACL will control which pages are visible.

When DokuWiki is in edit mode, the pagename and the dropdown menus are rendered in italic text. Clicking on a pagename in edit mode will insert that page name as a link at the caret.

With 'nspages' set to true, the namespace and page construct is replaced by that of pages and subpages. That is linking to a namespace will go to a page of the same name.  These namespace descriptive pages do not show in the dropdown menus. This change breaks DokuWiki's index, however the index functionality is provided by the dropdowns.

Setting 'addpage' set to true, will show a form to directly add pages and subpages.

There are various stylistic changes.  These may be modified by editing the appropriate CSS.

===== Cautions =====

  * This is an initial release.  I am not a programmer. Beware.
  * There is currently no caching for the menus.  On large sites this could result in excessive server load and download time

===== Compatible browsers =====

Amanuensis works reasonably well in the following browsers:

  * IE win
  * Firefox
  * Opera

===== Non-compatible browsers =====

The code for the dropdowns is problematic in some browsers.  Please help by listing problematic browsers, so i can add browser sniffing to degrade them gracefully.

  * IE mac

No wonder why, Microsoft stopped upgrading IE Mac for more than 6 years now. Anyway, There is much better than IE on a Mac... And believe me, Amanuensis works really fine on Safari, Shira, Firefox, Netscape or Camino.

===== Credits =====

This template uses a dropdown menu,

SWIM2.0 :: Simple website menu by brothercake http://www.brothercake.com/

Licensed under GPL -- http://www.gnu.org/copyleft/gpl.html

===== Revision List =====

  * 2005-11-30 --- initial release

===== Discussion =====

  * Warning: strpos(): Empty delimiter. in z:\home\public\www\docs\lib\tpl\amanuensis\inc\index.php on line 98 after pasting code from section "To show pages describing namespaces" into doku.php. The rest works fine. --- //[[sergeev_av@zelnet.ru|Alexander Kraeved]] 2005-12-05 17:14//

  * This problem is fixed by adding the following line to **/conf/local.php**  --- //[[greenboxster@gmail.com|Green Box]] 2006-01-07 11:40//

   $conf['amanuensis']['nssuffix'] = '-_dx';

==== Summary Drop Table width ====

{{ http://www.greguti.com/julianjaynes/buglisting.png?60|clic to enlarge}}Really great template, smooth and simple and elegant. Bravo! My only complaint is about the Summary Drop Table on the upper right of a page. It looks like the width of it is really too short, so that each entry is printed in 2 or 3 rows, even with very short titles... Is it a bug with Firefox? Can I change it to a better width? Here is a screenshot, more clear than my weird English.

==== Up-right menu display question ====

Am wondering if anyone could suggest as how I could modify to make the up-right menu fully display in the language of my choice (e.g. big5 encoding).

Please refer to this image[[http://allergy.kmu.edu.tw/.temp/up-right_menu.jpg]] pertaining to my question, thanks. 

===== Sites using this Template =====

  * [[http://mail.minifienixon.com/amanuensis/doku.php?id=wiki:playground|Playground]]