===== txt2tags plugin for DokuWiki =====


---- plugin ----
description: Parses txt2tags.
author     : Eric Forgeot, derived from markdownextra plugin by Joonas Pulakka and Jiang Le
email      : 
type       : syntax
lastupdate : 2014-05-19
compatible : Adora Belle, Weatherwax, Binky, Ponder Stibbons
depends    : 
conflicts  :
similar    :  
tags       : formatting, markup_language
downloadurl: https://bitbucket.org/farvardin/txt2tags-tools/downloads/txt2tags_dokuwiki.zip
bugtracker : https://bitbucket.org/farvardin/txt2tags-tools/issues
sourcerepo : https://bitbucket.org/farvardin/txt2tags-tools/
----



==== Download ====

Download and install the plugin using the Plugin Manager using the following URL. Refer to [[plugin:plugin|Plugin Manager]] on how to install plugins manually (hint: copy the extracted 'txt2tags' folder into dokuwiki/lib/plugins/)

	* https://bitbucket.org/farvardin/txt2tags-tools/downloads/txt2tags_dokuwiki.zip


Also available on bitbucket:

	* https://bitbucket.org/farvardin/txt2tags-tools/


==== Installation and usage ====

=== Txt2tags light users ===

//(for an occasional usage of txt2tags)//

By default, if the page name ends with ''.t2t'' suffix, it gets automatically parsed using txt2tags-php. 

To use that txt2tags markup in other pages, the content must be embedded in a ''t2t'' block. For example:

<code>
    <t2t>
    = Header =

    ```
    some code
    ```

    Paragraph

    == Header ==

    - A
    - simple
    - list

    + And
    + numbered
    + list
    

    Quite intuitive: 
    
    //italic//, **strong**, __underlined__, --strike-through-- etc.
    
    </t2t>
</code>

For the full syntax, refer to http://www.txt2tags.org


=== Txt2tags heavy users ===

//(enable txt2tags globally)//

If you want to enable txt2tags for the whole website, just delete or comment in ''action.php'' this line:

    if(substr($ID,-4) != '.t2t') return true; 


==== Toolbar ====

You may wish to replace ''toolbar.php'' in ''dokuwiki/inc/'' so you'll get a txt2tags-aware toolbar for your dokuwiki installation. For enabling internal link support, you'll also have to replace ''linkwiz.js'' into ''dokuwiki/lib/scripts/''

You may wish to enable the table creation wizard, to do so, include this just before the </body> tag, at the end of your template main.php file, like this:
     
    <script src="lib/plugins/txt2tags/tables.js" type="text/javascript"></script>
  


==== Power user usage ====

You can edit config.t2t located in the txt2tags plugin folder (''lib/plugins/txt2tags/'') of your dokuwiki installation so you can tweak more your txt2tags rendering using regex. 



==== changelog ====

	* 2014-05-19: improved toolbar
	* 2014-05-18: update with an external t2t file to add more control on the result
	* 2012-12-11: Initial release


==== bugs ====

It's basically a simple adaptation from the [[plugin:markdownextra]] plugin, using a txt2tags converter instead of the markdown one. While it seems to works well, there might be some glitches. If you find any, please report them on the bug tracker