1====== Formatting+ Syntax ======
2
3There are many plugins that provide additional XHTML formatting for
4DokuWiki. But the syntax isn't always consistent or compatible with
5other plugins. I believed the best solution is a unified plugin.
6
7===== Usage =====
8
9A drop-down menu containing shortcuts for all the formatting styles
10is added to the edit toolbar.
11
12The inline formatting syntax is as follows:
13
14^     Style    ^   Syntax   ^    XHTML Tag            ^
15|     Variable | %%??..??%% | VAR                     |
16|   Definition | %%@@..@@%% | DFN                     |
17|     Citation | %%&&..&&%% | CITE                    |
18|     Keyboard | %%``..``%% | KBD                     |
19|     Citation | %%$$..$$%% | SAMP                    |
20|  Superscript | %%/^..^/%% | SUP                     |
21|    Subscript | %%/,..,/%% | SUB                     |
22|       Insert | %%/+..+/%% | INS CLASS=simple        |
23|       Delete | %%/-..-/%% | DEL CLASS=simple        |
24|      Inverse | %%/!..!/%% | EM CLASS=inverse        |
25|   Small-Caps | %%!!..!!%% | STRONG CLASS=smallcaps  |
26|        Quote | %%""..""%% | Q                       |
27
28There are three block formats:
29
30^      Style    ^       Syntax                      ^    XHTML Tag               ^
31|  Block Insert | %%<ins title =cite @date></ins>%% | INS CLASS=block            |
32|  Block Delete | %%<del title =cite @date></del>%% | DEL CLASS=block            |
33|   Block Quote | %%<quote cite></quote>%%          | BLOCKQUOTE CLASS=citation  |
34
35The block insert and delete styles will also wrap the text in a ''DIV''
36block with the class name ''inserted'' or ''deleted''. XHTML requires
37this to determine whether the tag is being used inline or as a block.
38
39The block styles, as well as the inline quote style, can have attributes.
40All attributes are optional. For inline quotes, the cite attribute can
41be specified like this: %%""=cite|..""%%
42
43The included stylesheet is intended for browsers that fully support CSS2.
44This does not include Microsoft Internet Explorer, however. The plugin
45outputs a JavaScript function that uses DHTML to compensate.
46
47===== Configuration =====
48
49The plugin allows you to disable individual styles. In the configuration
50manager, select the formatting styles that you do not want to use.
51If the option ''classic_del'' is selected, then DokuWiki's default
52block delete will be used when there are no attributes, but the syntax
53with attributes will be handled by the plugin.
54
55The editor buttons are added in a sub-menu of the toolbar. If the ''toplevel''
56option is set, then buttons are shown in the main toolbar.
57
58===== License =====
59
60This plugin is licensed under the terms of the GNU General Public License.
61You are free to use, copy, modify, etc. If you like the plugin and want
62to do something nice for me, please consider dropping a few clams in
63the tip-bucket.
64
65Copyright (C) 2010  Tom N Harris <tnharris@whoopdedo.org>
66
67This program is free software; you can redistribute it and/or modify
68it under the terms of the GNU General Public License as published by
69the Free Software Foundation; either version 2 of the License, or
70(at your option) any later version.
71
72This program is distributed in the hope that it will be useful,
73but WITHOUT ANY WARRANTY; without even the implied warranty of
74MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
75GNU General Public License for more details.
76
77You should have received a copy of the GNU General Public License
78along with this program; if not, write to the Free Software
79Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
80