» about » content » twitter » github »


RoqWiki

  A wiki generator that converts ascii text files that are in
  Roqet Document Format into an HTML document.
  RoqWiki was inspired by pwyky, an Python wiki (but contains
  no source-code from that project).

Install

  0. Download RoqWiki: <http://www.roqet.org/software.html>;
  1. Create a new script-writable directory on your server
  2. Upload roqwiki.pl to your server and rename it to index.cgi
  3. Change permissions on index.cgi to 755
  4. Create a .htaccess file in the same directory with the
     following contents:
     DirectoryIndex index.cgi
     Options -MultiViews
     RewriteEngine on
     RewriteBase /test
     RewriteRule ^@[a-z]+/([A-Za-z0-9-]+)$ index.cgi [L]
     RewriteRule ^([A-Za-z0-9-]+)$ index.cgi [L]
     RewriteRule ^([A-Za-z0-9-]+)\.html$ - [L]
  5. Browse to http://yourdomainname/yourdirectory/index.cgi
  When the index.cgi is run the first time, it will create the 
  template files and stylesheet files for your later modification.

Further Configuration

  If you want to remove editing from the wiki, create a file in 
  the same directory called roqwiki.xml with the following format:
  <?xml version="1.0" encoding="UTF-8"?>
  <!-- roqwiki settings -->
  <parameters>
    <!-- allow_edit=0 to remove the "Edit this Page" link -->
    <!-- allow_edit=1 to add the "Edit this Page" link -->
    <allow_edit>1</allow_edit>
    <!-- "Deploy Page" only shown if allow_edit=1 -->
    <deploy_location>../</deploy_location>
    <!-- Exclude files from group deploy: exclude_files=file1,file2,...filex -->
    <exclude_files>wiki.html</exclude_files>
  </parameters>
  If your source contains comments that you don't want visible
  to the word, you should password-protect the created "source"
  directory.

Roqet Document Format

  The format of an  Roqet Document Format is as follows:
  - (comment)
  @ heading (heading) 
  * bullet (depreciated)
  *** bullet (new style)
  *-* horizontal line
  command = description and [examples] (descriptive line)
  [code]
  {{link~~linkname}} 
  {*imagelink*} 
  [[
  preformatted block (puts in <pre></pre> tag block)
  ]]
  - -->import:filename to import an external file

The Template File

  RoqWiki will generate an HTML Template File, you can then modify it to
  include whatever you want (Google search for example). The template must
  contain these tags
  (*title*)
  (*body*)
  (*draftdate*)

index


To Do

  Add more meta pages:
    grep (search)
    help (can build into about perhaps)

index


ChangeLog

  2008-04-16 :: 1.0 :: Initial release some code came from roqdocbuild.pl
  2008-04-17 :: 1.1 :: Bugfixes on display, create and URI limits
  2008-04-18 :: 1.2 :: Tweaks on formatting
  2008-05-19 :: 1.3 :: Added a body div for more refined formatting
  2008-06-06 :: 1.4 :: Added build all functionality
  2008-06-13 :: 1.5 :: Cleaned up code to use template for all page builds
  2009-05-11 :: 1.6 :: Changed info tag about imports not being within pre tags
  2009-06-03 :: 1.7 :: Added new-style bullets and horizontal lines.
  2009-12-23 :: 1.8 :: Added ability to deploy a single page to another location.
  2009-12-23 :: 1.9 :: Changed parameter file to be an xml file.

index


Author

  roqet <http://www.roqet.org>;

index


Copyright

  RoqWiki Perl script copyright 2009 roqet <http://www.roqet.org>;.
  RoqWiki can be distributed and modified under the terms of the
  GNU General Public License: http://www.gnu.org/copyleft/gpl.html
  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.
  Updates and other scripts and software available at:
  http://www.roqet.org/software.html
   ~~~
   'l'
    -

index

© Roqet 2018 :: 2018-05-11 17:07:11