1= txt2tags plugin for DokuWiki =
2
3"""
4---- plugin ----
5description: Parses txt2tags.
6author     : Eric Forgeot, derived from markdownextra plugin by Joonas Pulakka and Jiang Le
7email      :
8type       : syntax
9lastupdate : 2014-05-19
10compatible : Adora Belle, Weatherwax, Binky, Ponder Stibbons
11depends    :
12conflicts  :
13similar    :
14tags       : formatting, markup_language
15downloadurl: https://bitbucket.org/farvardin/txt2tags-tools/downloads/txt2tags_dokuwiki.zip
16bugtracker : https://bitbucket.org/farvardin/txt2tags-tools/issues
17sourcerepo : https://bitbucket.org/farvardin/txt2tags-tools/
18----
19"""
20
21
22
23== Download ==
24
25Download 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/)
26
27- https://bitbucket.org/farvardin/txt2tags-tools/downloads/txt2tags_dokuwiki.zip
28
29
30Also available on bitbucket:
31
32- https://bitbucket.org/farvardin/txt2tags-tools/
33
34
35== Installation and usage ==
36
37=== Txt2tags light users ===
38
39//(for an occasional usage of txt2tags)//
40
41By default, if the page name ends with ``.t2t`` suffix, it gets automatically parsed using txt2tags-php.
42
43To use that txt2tags markup in other pages, the content must be embedded in a ``t2t`` block. For example:
44
45''<code>''
46    <t2t>
47    = Header =
48
49    ```
50    some code
51    ```
52
53    Paragraph
54
55    == Header ==
56
57    - A
58    - simple
59    - list
60
61    + And
62    + numbered
63    + list
64
65    Quite intuitive?
66
67    //italic//, **strong**, __underlined__ etc.
68
69    </t2t>
70''</code>''
71
72For the full syntax, refer to http://www.txt2tags.org
73
74
75=== Txt2tags heavy users ===
76
77//(enable txt2tags globally)//
78
79If you want to enable txt2tags for the whole website, just delete or comment in ``action.php`` this line:
80
81``` if(substr($ID,-4) != '.t2t') return true;
82
83
84==== Toolbar ====
85
86You 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/``
87
88You 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:
89
90``` <script src="lib/plugins/txt2tags/tables.js" type="text/javascript"></script>
91
92
93
94==== Power user usage ====
95
96You 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.
97
98
99
100== changelog ==
101
102- 2014-05-18: improved toolbar
103- 2014-05-18: update with an external t2t file to add more control on the result
104- 2012-12-11: Initial release
105
106
107== Bugs ==
108
109It'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
110