MoaiEditor plugin for DokuWiki
                ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

Documentation and source code
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
   Documentation, source code and explanatory videos for this plugin 
   can be found at: https://moaitools.org/dokuwiki/plugins/moaieditor

Instalation
‾‾‾‾‾‾‾‾‾‾‾
   If you install this plugin manually, make sure it is installed in
   lib/plugins/moaieditor/ - if the folder is called different it
   will not work!

   Please refer to http://www.dokuwiki.org/extensions for additional 
   info on how to install extensions in DokuWiki.

Instructions for supporting other templates
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾     
   0. If MoaiEditor's toggle button is not showing up in the Doku-
      wiki editing page, it is because it had trouble locating some
      of the HTML elements it needs in order to work. So, before
      anything else, open the browser's console to see the error.
      Most probably it will tell you that it could not locate certain
      element. Or it might throw an error because it could not parse
      the content of an element. After you know the issue, proceed
      with the following steps.
   
   1. Start by copying any of the existing JS template files located
      in the 'templates/' directory of the plugin. For example copy
      'sprintdoc.js' and rename it to something like 'mytemplate.js'.
      The only JS file in that directory you should NOT use as a
      starting point is 'default.js'.
   
   2. Modify the contents of the file according to what it is explained
      in the comments of said file.
 
   3. In 'script.js':
        (a) Add the following line to the start of the script:         
            /* DOKUWIKI:include templates/mytemplate.js */            
            (be sure to surround the line by slashes and asterisks
            like the other ones)    
        (b) Add your chosen filename to the 'moaiEditor_templates'
            array. For example: 'mytemplate'.

   4. Optionally add a CSS file to the 'templates/' folder with the
      same name as your other file. For example: 'mytemplate.css'.
      This is only necesary if you want to fine-tune the look of 
      the editor to match your template.

----

Copyright (C) 2026  MoaiTools <info@moaitools.org>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.