1{* $Id$ *} 2{* \brief Show wiki syntax help 3 * included by tiki-show_help.tpl via smarty_block_add_help() 4 * TODO: Add links to add samples to edit form *} 5 6<h3>{tr}Wiki Syntax{/tr}</h3> 7{if $prefs.feature_help eq 'y'} 8 {remarksbox type="info" title="{tr}More information{/tr}"} 9 <a href="{$prefs.helpurl}Wiki+Page+Editor" target="tikihelp" class="tikihelp alert-link" title="{tr}Wiki Page Editor:{/tr} {tr}More help on editing wiki pages{/tr}"> 10 {tr}Wiki Page Editor{/tr} 11 </a> 12 {tr}and{/tr} 13 <a href="{$prefs.helpurl}Wiki-syntax" target="tikihelp" class="tikihelp alert-link" title="{tr}Wiki Syntax:{/tr} {tr}The syntax system used for creating pages in Tiki{/tr}"> 14 {tr}Wiki Syntax{/tr} 15 </a> 16 {/remarksbox} 17{/if} 18<table class="table table-condensed table-hover"> 19 <th> 20 {tr}Wiki Syntax{/tr} 21 </th> 22 {if (!isset($wysiwyg) or $wysiwyg ne 'y') or (isset($wysiwyg) and $wysiwyg eq 'y' and $prefs.wysiwyg_wiki_parsed eq 'y')} 23 <tr> 24 <td> 25 {icon name='bold'} <strong>{tr}Bold text{/tr}</strong> __{tr}text{/tr}__ 26 </td> 27 </tr> 28 <tr> 29 <td> 30 {icon name='italic'} <strong>{tr}Italic text{/tr}</strong> 2 {tr}single quotes{/tr} ('). '"{tr}text{/tr}"' 31 </td> 32 </tr> 33 <tr> 34 <td> 35 {icon name='underline'} <strong>{tr}Underlined text{/tr}</strong> ==={tr}text{/tr}=== 36 </td> 37 </tr> 38 <tr> 39 <td> 40 {icon name='font' istyle='color:red'} <strong>{tr}Colored text{/tr}</strong> <br/> ~~#FFEE33:{tr}text{/tr}~~ {tr}or{/tr} ~~yellow:{tr}text{/tr}~~. {tr}Will display using the indicated HTML color or color name. Color name can contain two colors separated by a comma. In this case, the first color would be the foreground and the second one the background.{/tr} 41 </td> 42 </tr> 43 <tr> 44 <td> 45 {icon name='strikethrough'} <strong>{tr}Deleted text{/tr}</strong> {tr}2 dashes{/tr} "-". --{tr}text{/tr}-- 46 </td> 47 </tr> 48 <tr> 49 <td> 50 {icon name='h1'} <strong>{tr}Headings{/tr}</strong> <br/> !heading1, !!heading2, !!!heading3 51 </td> 52 </tr> 53 <tr> 54 <td> 55 <strong>{tr}Show/Hide{/tr}</strong> <br/> !+, !!- {tr}show/hide heading section. + (shown) or - (hidden) by default{/tr}. 56 </td> 57 </tr> 58 <tr> 59 <td> 60 <strong>{tr}Autonumbered Headings{/tr}</strong> <br/> !#, !!#, !+#, !-# ... 61 </td> 62 </tr> 63 {/if}{* wysiwyg *} 64 <tr> 65 <td> 66 <strong>{tr}Table of contents{/tr}</strong> <br/>{tr}{literal}{toc}{/literal}, {literal}{maketoc}{/literal} prints out a table of contents for the current page based on structures (toc) or ! headings (maketoc){/tr}. {tr}Common optional parameters for maketoc are: title|maxdepth|levels|nums, and for toc are: order|showdesc|shownum|structId|maxdepth|pagename.{/tr} 67 </td> 68 </tr> 69 {if (!isset($wysiwyg) or $wysiwyg ne 'y') or (isset($wysiwyg) and $wysiwyg eq 'y' and $prefs.wysiwyg_wiki_parsed eq 'y')} 70 <tr> 71 <td> 72 {icon name='horizontal-rule'} <strong>{tr}Horizontal rule{/tr}</strong> -<em></em>-<em></em>-<em></em>- 73 </td> 74 </tr> 75 <tr> 76 <td> 77 {icon name='box'} <strong>{tr}Text box{/tr}</strong> ^{tr}Box content{/tr}^ 78 </td> 79 </tr> 80 <tr> 81 <td> 82 {icon name='align-center'} <strong>{tr}Centered text{/tr}</strong> {if $prefs.feature_use_three_colon_centertag eq 'y'}:::{tr}text{/tr}:::{else}::{tr}text{/tr}::{/if} 83 </td> 84 </tr> 85 {/if}{* wysiwyg *} 86 <tr> 87 <td> 88 {icon name='cog'} <strong>{tr}Dynamic variables{/tr}</strong> <br/> %{tr}Name{/tr}% {tr}Inserts an editable variable{/tr} 89 </td> 90 </tr> 91 <tr> 92 <td> 93 {icon name='link-external'} <strong>{tr}External links{/tr}</strong> <br/> {tr}use square brackets for an external link: [URL], [URL|link_description],[URL|link_description|relation] or [URL|description|relation|nocache] (that last prevents the local Wiki from caching the linked page; relation can be used to insert rel attribute for the link - useful e.g. for shadowbox).{/tr}<br>{tr}For an external Wiki, use ExternalWikiName:PageName or ((External Wiki Name: Page Name)){/tr} 94 </td> 95 </tr> 96 <tr> 97 <td> 98 <strong>{tr}Square Brackets{/tr}</strong> <br/> {tr}Use [[foo] to show [foo].{/tr} 99 </td> 100 </tr> 101 <tr> 102 <td> 103 {icon name='link'} <strong>{tr}Wiki references{/tr}</strong> <br/> {if $prefs.feature_wikiwords eq 'y'}{tr}JoinCapitalizedWords or use{/tr} {/if}(({tr}page{/tr})) {tr}or{/tr} (({tr}page|description{/tr})) {tr}for wiki references{/tr} 104 {if $prefs.wikiplugin_alink eq 'y'} 105 , (({tr}page|#anchor{/tr})) {tr}or{/tr} (({tr}page|#anchor|desc{/tr})) {tr}for wiki heading/anchor references{/tr} 106 {/if} 107 {if $prefs.feature_wikiwords eq 'y'}, )){tr}SomeName{/tr}(( {tr}prevents referencing{/tr}{/if} 108 </td> 109 </tr> 110 {if (!isset($wysiwyg) or $wysiwyg ne 'y') or (isset($wysiwyg) and $wysiwyg eq 'y' and $prefs.wysiwyg_wiki_parsed eq 'y')} 111 <tr> 112 <td> 113 {icon name='list'} {icon name='list-numbered'} <strong>{tr}Lists{/tr}</strong> <br> * {tr}for bullet lists{/tr}, # {tr}for numbered lists{/tr}, ;{tr}Word:{/tr}{tr}definition{/tr} {tr}for definiton lists{/tr} 114 </td> 115 </tr> 116 <tr> 117 <td> 118 <strong>{tr}Indentation{/tr}</strong> <br/>+, ++ {tr}Creates an indentation for each plus (useful in list to continue at the same level){/tr} 119 </td> 120 </tr> 121 {if $prefs.feature_wiki_tables eq 'new'} 122 <tr> 123 <td> 124 {icon name='table'} <strong>{tr}Tables{/tr}</strong> <br/> || {tr}row{/tr}1-{tr}col{/tr}1 | {tr}row{/tr}1-{tr}col{/tr}2 | {tr}row{/tr}1-{tr}col{/tr}3<br>{tr}row{/tr}2-{tr}col{/tr}1 | {tr}row{/tr}2-{tr}col{/tr}2 | {tr}row{/tr}2-{tr}col{/tr}3 || 125 </td> 126 </tr> 127 {else} 128 <tr> 129 <td> 130 {icon name='table'} <strong>{tr}Tables{/tr}</strong> <br/> ||{tr}row{/tr}1-{tr}col{/tr}1|{tr}row{/tr}1-{tr}col{/tr}2|{tr}row{/tr}1-{tr}col{/tr}3||{tr}row{/tr}2-{tr}col{/tr}1|{tr}row{/tr}2-{tr}col{/tr}2|{tr}row{/tr}2-{tr}col{/tr}3|| 131 </td> 132 </tr> 133 {/if} 134 <tr> 135 <td> 136 {icon name='title'} <strong>{tr}Title bar{/tr}</strong> -={tr}Title{/tr}=- 137 </td> 138 </tr> 139 <tr> 140 <td> 141 <strong>{tr}Monospace font{/tr}</strong> -+{tr}Code sample{/tr}+- 142 </td> 143 </tr> 144 {/if}{* wysiwyg *} 145 <tr> 146 <td> 147 <strong>{tr}Line break{/tr}</strong> <br/>%%% {tr}(very useful especially in tables){/tr} 148 </td> 149 </tr> 150 <tr> 151 <td> 152 <strong>{tr}Multi-page pages{/tr}</strong> <br/>{tr}Use{/tr} ...page... {tr}to separate pages{/tr} 153 </td> 154 </tr> 155 <tr> 156 <td> 157 <strong>{tr}Non-parsed sections{/tr}</strong> <br/> ~np~ {tr}data{/tr} ~/np~ {tr}Prevents wiki parsing of the enclosed data.{/tr} 158 </td> 159 </tr> 160 <tr> 161 <td> 162 <strong>{tr}Preformated sections{/tr}</strong> <br/> {tr}~pp~ data ~/pp~ Displays preformated text/code; no Wiki processing is done inside these sections (as with np), and the spacing is fixed (no word wrapping is done). ~pre~ data ~/pre~ also displayes preformatted text with fixed spacing, but wiki processing still occurs on the text.{/tr} 163 </td> 164 </tr> 165 <tr> 166 <td> 167 <strong>{tr}Comments{/tr}</strong> <br/> {tr}~tc~ Tiki Comment ~/tc~ makes a Tiki comment. It will be completely removed from the display, but saved in the file for future reference. ~hc~ HTML Comment ~/hc~ makes an HTML comment. It will be inserted as a comment in the output HTML; these are not normally displayed in browsers, but can be seen using "View Source" or similar.{/tr} 168 </td> 169 </tr> 170 {if $prefs.feature_wiki_monosp eq 'y'} 171 <tr> 172 <td> 173 <strong>{tr}Block Preformatting{/tr}</strong> <br/> {tr}Indent text with any number of spaces to change it to a monospaced block that still follows other Wiki formatting instructions. It will be indented with the same number of spaces that are used. Note that this mode does not preserve exact spacing and line breaks; use ~pp~...~/pp~ for that.{/tr} 174 </td> 175 </tr> 176 {/if} 177 <tr> 178 <td> 179 <strong>{tr}Direction{/tr}</strong> <br/>{literal}{r2l}{/literal}, {literal}{l2r}{/literal}, {literal}{rm}{/literal}, {literal}{lm}{/literal}{tr}Insert with respect to right-to-left and left-to-right text direction DIV (up to end of text) and markers for langages as Arabic and Hebrew.{/tr} 180 </td> 181 </tr> 182 <tr> 183 <td> 184 <strong>{tr}Special characters{/tr}</strong> <br/> 185 {literal}~hs~{/literal} {tr}hard space{/tr}, 186 {literal}~c~{/literal} ©, 187 {literal}~amp~{/literal} &, 188 {literal}~lt~{/literal} <, 189 {literal}~gt~{/literal} >, 190 {literal}~ldq~{/literal} “, 191 {literal}~rdq~{/literal} ”, 192 {literal}~lsq~{/literal} ‘, 193 {literal}~rsq~{/literal} ’, 194 {literal}~--~{/literal} —, 195 {literal}~bs~{/literal} \, 196 {tr}numeric between ~ for HTML numeric characters entity{/tr} 197 </td> 198 </tr> 199</table> 200 201{if $prefs.feature_wiki_paragraph_formatting eq 'y'} 202 {remarksbox type="info" title="{tr}Note{/tr}" close="n"} 203 {tr}Because the wiki paragraph formatting feature is on, all groups of non-blank lines are collected into paragraphs. Lines can be of any length, and will be wrapped together with the next line. Paragraphs are separated by blank lines.{/tr} 204 {/remarksbox} 205{else} 206 {remarksbox type="info" title="{tr}Note{/tr}" close="n"} 207 {tr}Because the Wiki paragraph formatting feature is off, each line will be presented as you write it. This means that if you want paragraphs to be wrapped properly, a paragraph should be all together on one line.{/tr} 208 {/remarksbox} 209{/if} 210