help.en

Read this help in French. Lire cette aide en français.

Read the full syntax help.

Lionwiki-t2t is a wiki system for the creation and maintenance of websites.

Lionwiki-t2t pages looks the same as normal webpages, but in addition they have an "Edit" link which helps to edit or add new pages on a website, with a lightweight markup language, like for http://www.wikipedia.org.

This system has some ready to use extensions and a simplified and customisable syntax.

Presentation (Edit)

The pages on this site are wiki-based pages, which means that pages can be created and edited by multiple authors. To edit a page, click on the "edit" link which exists somewhere on the page (generally at the top or in the footer). Some pages may be protected by a password.

In this wiki, unless you're using an integrated system such as YunoHost, the default password is "demo". It is adviced to modify it after the installation (see below).

When you edit a page, you see the markup which describe the content of the page. The final rendering, with the choosen formatting, will be displayed only after the page is saved.

The basic rules for page markup are simple (you will find them below).

Editing rules (syntax) (Edit)

The syntax of this wiki is following the general rules of txt2tags syntax, which you can find here as a reminder. The idea is you should be able to paste here your txt2tags documents without many modifications (explained in the second part of this document).

Basic Syntax (Edit)

table cell 2 cell 3 cell 4
table cell 2 cell 3 cell 4
  • You can also visit txt2tags' website to learn more about the syntax, or use the buttons for quick formatting.

  • Markdown: Some of the markdown syntax is also supported (headings, links) except for the most incompatible ones (italic).

Installation (Edit)

Linux / Unix (Edit)

Lionwiki is easy to install, no need to setup a sql database: a webserver (Apache, Lighttpd or Nginx) + php will be enough.

Here is what is possible to do:

(remove -minimal from the address above to get the complete version, with all templates and extensions)

Windows (Edit)

On windows system, get an HTTP server, such as XAMPP

  • Then download Lionwiki-t2t from here (or here for minimal version]

  • Put the uncompressed files from the previous archive into xampphtdocs

Android (Edit)

If you're on Android and you wish to use your tablet / phone / androidtv as a server, you can use this app which is a free webserver. Install the php plugin, and copy the files of the wiki into /sdcard/paw/html. Then visit http://localhost:8080/lionwiki-t2t from your android system.

YunoHost (Edit)

In Yunohost, you can install it by searching for "lionwiki" in the application store.

Docker (Edit)

Go into infra/docker and type "make run" to build an image and deploy a new container. Learn more in the doc in the infra/ folder.

Usage and configuration (Edit)

  • You can configure lionwiki-t2t by editing a few configuration files with the pheditor.php utility at the root of the installation. The default password is "admin" and you are advised to modify it after installation. (on the yunohost installation, the password set is the same as the one chosen during installation). If you think it might be a security breach, you can completely remove this editor from your installation or rename it.
  • top menu: you can customise your menu by editing the menu.php file in the root.
  • general configuration: see config.php. You can comment (ignore) a line with //. This file can set:
    • the title of the wiki
    • the password ($PASSWORD variable)
    • default theme ($TEMPLATE variable). In the case there are several variable with the same name, only the last variable is taken into account.
  • special configurations, regex etc: you can add extra customisation in your wiki by using the config.t2t file (see below)
    • you can have a look at sandbox_cyoa and its configuration file cyoa.t2t for an example of a special customisation template using this feature.

Txt2tags configuration (Edit)

config.t2t is called from the main index.php file, and therefore all replacements and configurations in it are concerning the whole wiki. You can have a look at the txt2tags manual for how to use the preproc and postproc directives.

Generally speaking, preproc are for customising the wiki syntax (adding new markup), and postproc are for adding extra html and css.

Let's say you wish to add the markdown headers in the wiki (it's already implemented, check config.t2t at the root of the lionwiki-t2t installation):

Then we add into config.t2t this syntax: 

%!preproc: '^# (.*?)$' '=  ='

it means it will process all text (.*?) starting with a # at the beginning of a line (^), until the end of the line ($) and replace it with the txt2tags markup for headings level 1 (= heading =).

Now let's say you wish to add the new @@SLIDER@@ markup into your website, then add this line into config.t2t: 

%!postproc: '@@SLIDER@@' '<input type="range" min="1" max="100" class="slider">'

it will result in:

You could also refine the markup by adding the min and max values with @@SLIDER@@1/100@@ which would give more sense. See the "progress bar" example into config.t2t for a similar case.

You can also define a set of rules only available for one page. Create a newrule.t2t at the root of the installation. Then include it into the page with: 

%!includeconf:newrule.t2t

At the moment there are :

  • cyoa.t2t for creating choose your own adventure elements (see sandbox_cyoa)

  • todotxt.t2t for parsing todo.txt files (see todo). You can synchronise and edit this todo.txt found in var/pages/todo.txt with other tools (official todo.txt cli, markor or simpletask on Android...)

  • abcjs.t2t to display musical scores in abc format (see sample.abc).

  • forth.t2t for writing and developing programs in the FORTH programming language (see sample.forth).

  • Markdown support could also have been placed in such a file, but has been integrated directly into the main config.t2t file.

Templates (Edit)

Templates are defining the general placement of elements of your wiki (menu on the top, "edit" on the right of the menu, or at the bottom instead etc.).

They are using simple HTML elements, which you can edit yourself. The curly brackets are for lionwiki-t2t special elements, like {EDIT}, {CONTENT}, {HOME}. By moving those elements elsewhere, you can redefine the template.

As said above, you can select the default template in the config.php file. Templates can be found in the templates/ folder. You can test and explore them. You can also select a default template on the admin page, but it will only change it locally (in your browser).

Templates folders also contains CSS themes which you can also customise further (see below).

Some notable templates (with several color schemes):

  • minimaxing: the default template for the wiki. Simple and clean.
  • newspaper: another clean template, great for a website.
  • terminal: choose black on white, green on black, for a console-like appearance.
  • geek: some simple contrasted colors.

More templates can be downloaded from https://github.com/farvardin/lionwiki-templates

Themes (Edit)

Most templates contain a .less file which define the general appearance (color scheme, font size and definition, size...). They also load a temporary .less file which can change foreground (@fg) and background (@bg) colors, as well as links and heading, and default font. This temporary .less file is feed by definition files from the templates/css/ folder and will also generate .css files inside its template folder, by using the associated makefile.

For example for the newspaper template, you can easily change:

  1. templates/newspaper/newspaper.html for putting the link on top instead of on bottom (or in addition to bottom)
  2. templates/newspaper/newspaper.less for changing main text width, line height, margins
  3. templates/css/newspaper_theme01.less for changing default colors and font

then generate the new theme with "make newspaper_theme01" inside /templates/newspaper folder (lessc is needed). newspaper.less is importing the "newspaper_temp.less" file. Then newspaper.less is called from within the newspaper.html template. You can remplace this dynamic generation (which will be slightly less optimized than a static .css file) by removing the less.js script, the newspaper.less link from newspaper.html, and call a link to newspaper_theme01.css instead for example.

Index (Edit)

You can create an index of all your pages by adding {INDEX_LIST} to a page (see page list). To highlight certain important pages, you can indicate in the title :

  • title#C777777# with 'C' + hexadecimal code of the color to see it appear as background color
  • title#CB# (or 'C' (as in 'color') + B for blue, V for violet, Y for yellow, R for red, O for orange and G for green)

If an internal link with such a title does not work, please replace the # with %23, e.g. page%23CY%23 instead of page#CY#

Synchronize (Edit)

To synchronise your wiki with your mobile devices, install this in addition:

  • (optionnal) install nextcloud : https://nextcloud.com/
  • (optionnal) share a subfolder containing your lionwiki install into owncloud
  • install foldersync or syncthing on an android device and synchronise the text files into var/pages/ between your server and your device (tablet, smartphone), using either ssh (recommended) or owncloud.
  • install for example the 920 text editor, Denkzettel or Markor on android and edit the pages of your website from your mobile device!

  • Bonus: if you're using Denkzettel, create a new page and start your first line with either #### or DENKZETTEL, then enable in the option "checklist on". This way you'll be able to use your wiki as a shopping list: Items are created by the application with a + before them, and disabled with a -, and with some preprocessing in the config.t2t we are able to display it correctly in lionwiki-t2t. Check this page to see a sample in action. (The ## characters are automatically added by denkzettel for adding a background color to the note).

Export as PDF (Edit)

You can also export some of your pages in pdf and use your wiki as a word processor / document generator. We use textallion for this. Install textallion on your server (installed by default in /usr/share/textallion/), copy the content of /usr/share/textallion/contrib/latexlib/* into /var/www/lionwiki-t2t/export_pdf/. Uncomment in /var/www/lionwiki-t2t/menu.php the part related to "Generate pdf". If textallion is correctly setup, you should be able to render a pdf document from the content of the "textallion" page from your wiki. You can edit /var/www/lionwiki-t2t/export_pdf/lionwiki.t2t to add more pages.

If it doesn't work as expected, run /var/www/lionwiki-t2t/export_pdf/run.php and trace the errors from there. When it's correctly set up, you should be able to do this from any browser which can access your lionwiki-t2t installation.

Avantages (Edit)

Some advantages:

  • data are stored in plain text, which are human readable and can be edited from an other application (for example a text editor on your smartphone)
  • simple and sober default theme (minimaxing). CSS using responsive design (for smartphone and tablets). You can easily customise colors using less.
  • Another option theme is using bootstrap, so you can use it as a basis for a modern website.

Tips (Edit)

  • if you need to make your image left, right or centered aligned, keep this in mind:
    • for left align, add an extra space (and/or some text) after the image mark
    • for center align, add an extra space (and/or some text) before and after the image mark
    • for right align, add an extra space (and/or some text) before the image mark

  • if you need to work further on the minimaxing design, rename in the template minimaxing.html the call to minimaxing.css to minimaxing.less

  • you can use you own handwriting font, just name it MyManuscript.ttf, put it in the templates/fonts folder (replace the existing one) and change the css/less file so it will be called before the other fonts.

  • You can also use your favorite font, rename if MyFont.ttf and put it in the templates/fonts folder (replace the existing one).

  • On linux or mac os x, it shouldn't be a problem to double-click on a word and only highlight that word, while on windows it would select also the white space after it, so you can't properly add the syntax. So on windows:
    • either single click after the last character of the word and press CTRL + SHIFT + LEFT ARROW
    • or if you're on mozilla firefox, in about:config, just search for layout.word_select. and select eat_space_to_next_word to False.

  • the var/pages folder is protected by .htaccess. Don't forget to enable it in both your /etc/apache2/sites-available/default and /etc/apache2/sites-available/default-ssl configurations!

Known bugs (Edit)

  • if you edit a part of the document, after saving you might need to reload the page if you want to edit a new part, otherwise the edit field will remain blank.
  • regex have problems with some replacements (among others, lionwiki doesn't keep the \ in regex). Instead include a t2t file using includeconf


#help
Powered by LionWiki-t2t. Last changed: September 3, 2024 at 9:19 PM CEST Erase cookies Edit History