Txt2tags

Summary:Txt2tags markup for PmWiki
Version:05 feb 2016
Prerequisites:
Status:Active
Maintainer: Farvardin
Categories: Markup
Users: +1 (View / Edit)

Questions answered by this recipe

  1. How can I use a logical, clean and simpler markup inside pmWiki?
  2. How can I use txt2tags tags or reuse txt2tags documents inside pmWiki pages?

Description

This recipe adds txt2tags formatting to the pmWiki markup. Most txt2tags tags are translated to their pmWiki equivalent and then passed through the standard PmWiki engine.

Installation

  1. Download the following file: txt2tags.phpΔ and save in your /cookbook directory.
  2. Add the following line into your local/config.php script:
    require_once ("cookbook/txt2tags.php");

If you wish to use the GUI icons for edition (included in pmwiki), add also:

And if you want the full GUI icons, download t2tguiedit.zipΔ and unzip it into your root $FarmD directory (it will expand files into cookbook and pub)

It will look like this when editing some text:

In the case the t2tguiedit folder is not found, it will no longer fallback to the default guiedit icons.

For your users, you should edit the /pmwiki/index.php/Site/EditQuickReference and add for example:

Visit [txt2tags' website http://txt2tags.sourceforge.net/markup.html] to learn more about the syntax, or use the icons for quick formatting.
Note: The devel version may be the most up to date: https://bitbucket.org/farvardin/pmwiki-efo

Release Notes

Here is the current state of what is working and what is not:

  • Title level : works
  • Numbered Title level : replaced by Title level
  • Table of content based on titles : works (you must use Cookbook/PageTableOfContents with it.)
  • A paragraph is made by one or more lines. A blank line separates them. : seems to work. Default in pm wiki.
  • A percent sign for comments : works (use one whitespace after %)
  • For beautifiers we have bold and italic. : works
  • There is also underline, strike and monospaced. : works
  • a list of items : works
  • More indent opens a sublist : works (limited to level 3 lists)
  • Two blank lines close all the lists. : one line break is enough to close the list.
  • Change the hyphen by a plus
  • And you have a numbered list : works
  • Definition list : not working very well
  • A quoted paragraph is prefixed by a TAB. : not working (not relevant on a web form)
  • verbatim area : works
  • Verbatim line prefixed with 3 backquotes. : works
  • Tables : not working well
  • single external url links : works (pmwiki behavior)
  • commented url links : works
  • txt2tags style inside links (without http) : works

If you need the version for pre-PHP5.5, get this file instead: txt2tags_prePHP5-5.phpΔ

See Also

Sample page showing this: http://anamnese.online.fr/pmwiki-efo/

you can edit the sandbox linking from this page with the password "pmwiki"

Contributors

Comments

User notes +1: If you use, used or reviewed this recipe, you can add your name. These statistics appear in the Cookbook listings and will help newcomers browsing through the wiki.