wiki_syntax_detailed_markdown.html 13.5 KB
Newer Older
1 2 3
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
4
<title>Formátování Wiki v Redminu</title>
5
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
7 8 9
</head>

<body>
10
<h1><a name="1" class="wiki-page"></a>Formátování Wiki (Markdown)</h1>
11

12
    <h2><a name="2" class="wiki-page"></a>Odkazy</h2>
13

14
        <h3><a name="3" class="wiki-page"></a>Odkazy Redmine</h3>
15

16
        <p>Redmine umožňuje hypertextové odkazy mezi jednotlivými zdroji (úkoly, revize, wiki stránky...) kdekoli, kde je použito Wiki formátování.</p>
17
        <ul>
18 19
            <li>Odkaz na úkol: <strong>#124</strong> (zobrazí <del><a href="#" class="issue" title="Hromadná změna nezmění kategorii úkolů (Uzavřeno)">#124</a></del>, odkaz je přeškrtnutý, jestliže je úkol uzavřen)</li>
            <li>Odkaz na poznámku k úkolu: <strong>#124-6</strong>, nebo <strong>#124#note-6</strong></li>
20 21
        </ul>

22
        <p>Odkazy Wiki:</p>
23 24

        <ul>
25 26 27
            <li><strong>[[Příručka]]</strong> zobrazí odkaz na stránku nazvanou "Příručka": <a href="#" class="wiki-page">Příručka</a>.</li>
            <li><strong>[[Příručka#čtěte-více]]</strong> Vás přenese ke kotvě "čtěte-více". Nadpisy mají automaticky přiřazené kotvy, na které se můžete odkazovat: <a href="#" class="wiki-page">Příručka</a>.</li>
            <li><strong>[[Příručka|Uživatelský manuál]]</strong> zobrazí odkaz na tu samou stránku, ale s jiným textem: <a href="#" class="wiki-page">Uživatelský manuál</a>.</li>
28 29
        </ul>

30
        <p>Můžete se také odkazovat na Wiki stránky jiného projektu:</p>
31 32

        <ul>
33 34 35 36 37 38

        <p>Můžete se také odkazovat na Wiki stránky jiného projektu:</p>

        <ul>
            <li><strong>[[projekt_test:Nějaká stránka]]</strong> zobrazí odkaz na stránku s názvem "Nějaká stránka" na Wiki projektu projekt_test.</li>
            <li><strong>[[projekt_test:]]</strong> zobrazí odkaz na hlavní Wiki stránku projektu projekt_test.</li>
39 40
        </ul>

41
        <p>Odkazy na Wiki stránky jsou zobrazeny červeně v případě, že odkazovaná stránka dosud neexistuje, např.: <a href="#" class="wiki-page new">Neexistující stránka</a>.</p>
42

43
        <p>Odkazy na další zdroje:</p>
44 45

        <ul>
46
            <li>Dokumenty:
47
                <ul>
48 49 50 51 52
                    <li><strong>document#17</strong> (odkaz na dokument s ID 17)</li>
                    <li><strong>document:Úvod</strong> (odkaz na dokument s názvem "Úvod")</li>
                    <li><strong>document:"Nějaký dokument"</strong> (Uvozovky se mohou použít v případě, že název obsahuje mezery.)</li>
                    <li><strong>projekt_test:document:"Nějaký dokument"</strong> (odkaz na dokument s názvem "Nějaký dokument" v jiném projektu "projekt_test")</li>
                </ul></li>
53 54 55
        </ul>

        <ul>
56
            <li>Verze:
57
                <ul>
58 59
                    <li><strong>version#3</strong> (odkaz na verzi s ID 3)</li>
                    <li><strong>version:1.0.0</strong> odkaz na verzi s názvem "1.0.0")</li>
60
                    <li><strong>version:"1.0 beta 2"</strong></li>
61 62
                    <li><strong>projekt_test:version:1.0.0</strong> (odkaz na verzi "1.0.0" jiného projektu "projekt_test")</li>
                </ul></li>
63 64 65
        </ul>

        <ul>
66
            <li>Přílohy:
67
                <ul>
68 69 70
                    <li><strong>attachment:soubor.zip</strong> (odkaz na přílohu aktuálního objektu s názvem soubor.zip)</li>
                    <li>Aktuálně mohou být odkazovány pouze přílohy aktuálního objektu (u úkolu mohou být odkazy pouze na přílohy danného úkolu).</li>
                </ul></li>
71 72 73
        </ul>

        <ul>
74
            <li>Revize:
75
                <ul>
76 77 78 79 80 81 82
                    <li><strong>r758</strong>                       (odkaz na revizi)</li>
                    <li><strong>commit:c6f4d0fd</strong>            (odkaz na revizi s nečíselným označním revize)</li>
                    <li><strong>svn1|r758</strong>                  (odkaz na revizi určitého repozitáře, pro projekty s více repozitáři)</li>
                    <li><strong>commit:hg|c6f4d0fd</strong>         (odkaz na revizi  s nečíselným označním revize určitého repozitáře, pro projekty s více repozitáři)</li>
                    <li><strong>projekt_test:r758</strong>               (odkaz na revizi jiného projektu)</li>
                    <li><strong>projekt_test:commit:c6f4d0fd</strong>    (odkaz na revizi  s nečíselným označním revize jiného projektu)</li>
                </ul></li>
83 84 85
        </ul>

        <ul>
86
             <li>Soubory repositáře:
87
                <ul>
88 89 90 91 92 93 94 95 96 97
                    <li><strong>source:some/file</strong>           (odkaz na soubor umístěný v /some/file respozitáře projektu)</li>
                    <li><strong>source:some/file@52</strong>        (odkaz na revizi souboru č. 52)</li>
                    <li><strong>source:some/file#L120</strong>      (odkaz na 120. řádek souboru)</li>
                    <li><strong>source:some/file@52#L120</strong>   (odkaz na 120. řádek revize souboru č. 52)</li>
                    <li><strong>source:"some file@52#L120"</strong> (použijte uvozovky, když URL obsahuje mezery)</li>
                    <li><strong>export:some/file</strong>           (vynutit stažení souboru)</li>
                    <li><strong>source:svn1|some/file</strong>      (odkaz na soubor určitého repozitáře, pro projekty s více repositáři)</li>
                    <li><strong>projekt_test:source:some/file</strong>   (odkaz na soubor umístěný v /some/file repositáře projektu "projekt_test")</li>
                    <li><strong>projekt_test:export:some/file</strong>   (vynutit stažení souboru umístěného v /some/file repositáře projektu "projekt_test")</li>
                </ul></li>
98 99 100
        </ul>

        <ul>
101
            <li>Diskuzní fóra:
102
                <ul>
103 104 105
                    <li><strong>forum#1</strong> (odkaz na fórum s id 1</li>
                    <li><strong>forum:Support</strong> (odkaz na fórum pojmenované Support)</li>
                    <li><strong>forum:"Technical Support"</strong> (Použij dvojté uvozovkym jestliže název fóra obsahuje mezery.)</li>
106
                </ul></li>
107 108 109
        </ul>

        <ul>
110
            <li>Příspěvky diskuzního fóra:
111
                <ul>
112 113
                    <li><strong>message#1218</strong> (odkaz na příspěvek s ID 1218)</li>
                </ul></li>
114 115
        </ul>

116

117
        <ul>
118
            <li>Projekty:
119
                <ul>
120 121 122 123
                    <li><strong>project#3</strong> (odkaz na projekt s ID 3)</li>
                    <li><strong>project:projekt_test</strong> (odkaz na projekt pojmenovaný "projekt_test")</li>
                    <li><strong>project:"projekt test"</strong> (odkaz na projekt pojmenovaný "projekt test")</li>
                </ul></li>
124 125 126
        </ul>

        <ul>
127
            <li>Novinky:
128
                <ul>
129 130 131 132
                    <li><strong>news#2</strong> (odkaz na novinku id 2)</li>
                    <li><strong>news:Greetings</strong> (odkaz na novinku "Greetings")</li>
                    <li><strong>news:"First Release"</strong> (použij dvojté uvozovky, jestliže název novinky obsahuje mezery)</li>
                </ul></li>
133 134 135 136 137
        </ul>

        <p>Escaping:</p>

        <ul>
138
            <li>Zabránit parsování Redmine odkazů, lze vložením vykřičníku před odkaz: !</li>
139 140 141
        </ul>


142
        <h3><a name="4" class="wiki-page"></a>Externí odkazy</h3>
143

144
        <p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
145 146 147 148 149

<pre>
http://www.redmine.org, someone@foo.bar
</pre>

150
        <p>zobrazí: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
151

152
        <p>Jestliže chcete zobrazit určitý text místo URL, můžete použít standardní syntaxi textile:</p>
153 154

<pre>
155
"Webová stránka Redmine":http://www.redmine.org
156 157
</pre>

158
        <p>zobrazí: <a href="http://www.redmine.org" class="external">Webová stránka Redmine</a></p>
159 160


161
    <<h2><a name="5" class="wiki-page"></a>Formátování textu</h2>
162 163


164
    <p>Pro nadpisy, tučný text, tabulky a seznamy, Redmine podporuje syntaxi Textile.  Podívejte se na <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> pro informace o využití těchto vlastností. Několik příkladů je uvedeno níže, ale Textile toho dokáže mnohem víc.</p>
165

166
        <h3><a name="6" class="wiki-page"></a>Styly písma</h3>
167 168

<pre>
169 170 171 172
* **tučný**
* *kurzíva*
* ***tučná kurzíva***
* ~~přeškrtnutý~~
173 174
</pre>

175
        <p>Zobrazí:</p>
176 177

        <ul>
178 179 180 181
            <li><strong>tučný</strong></li>
            <li><em>kurzíva</em></li>
            <li><em><strong>tučná kurzíva</strong></em></li>
            <li><del>přeškrtnutý</del></li>
182 183
        </ul>

184
        <h3><a name="7" class="wiki-page"></a>Vložené obrázky</h3>
185 186

        <ul>
187 188
            <li><strong>![](image_url)</strong> zobrazí obrázek z odkazu (syntaxe markdown)</li>
            <li>Jestliže máte obrázek přiložený k Wiki stránce, může být zobrazen jako vložený obrázek pomocí jeho jména: <strong>![](attached_image)</strong></li>
189 190 191 192 193
        </ul>

        <h3><a name="8" class="wiki-page"></a>Headings</h3>

<pre>
194 195 196
# Nadpis 1. úrovně
## Nadpis 2. úrovně
### Nadpis 3. úrovně
197 198
</pre>

199
<p>Redmine přiřadí kotvu ke každému nadpisu, takže se na ně lze odkazovat pomocí "#Nadpis", "#Podnadpis" atd.</p>
200 201


202
        <h3><a name="10" class="wiki-page"></a>Odstavce</h3>
203

204
        <p>Začněte odstavec s <strong>&gt;</strong></p>
205 206

<pre>
207 208
&gt; Rails je framework pro vývoj webových aplikací podle modelu Model-View-Control.
Vše, co je potřeba, je databázový a webový server.
209 210
</pre>

211
        <p>Zobrazí:</p>
212

213 214
       <blockquote>
                <p>Rails je framework pro vývoj webových aplikací podle modelu Model-View-Control.<br />Vše, co je potřeba, je databázový a webový server.</p>
215 216 217
        </blockquote>


218
        <h3><a name="11" class="wiki-page"></a>Obsah</h3>
219 220

<pre>
221 222
{{toc}} =&gt; obsah zarovnaný doleva
{{&gt;toc}} =&gt; obsah zarovnaný doprava
223 224
</pre>

225
        <h3><a name="14" class="wiki-page"></a>Vodorovná čára</h3>
226 227 228 229 230 231 232

<pre>
---
</pre>

    <h2><a name="12" class="wiki-page"></a>Macros</h2>

233
    <p>Redmine obsahuje následující vestavěná makra:</p>
234 235 236 237

    <p>
    <dl>
      <dt><code>hello_world</code></dt>
238
      <dd><p>Jednoduché makro.</p></dd>
239 240

      <dt><code>macro_list</code></dt>
241
      <dd><p>Zobrazí seznam všech dostupných maker, včetně jejich popisu, existuje-li.</p></dd>
242 243

      <dt><code>child_pages</code></dt>
244 245 246
      <dd><p>Zobrazí seznam dětských stránek. Bez parametrů zobrazí dětské stránky aktuální wiki stránky. Např.:</p>
      <pre><code>{{child_pages}} -- lze použít pouze z wiki stránky
{{child_pages(depth=2)}} -- zobrazí dětské stránky pouze do 2. úrovně</code></pre></dd>
247

248 249
     <dt><code>include</code></dt>
      <dd><p>Vloží Wiki stránku. Např.:</p>
250 251 252 253 254
      <pre><code>{{include(Foo)}}</code></pre>
      <p>or to include a page of a specific project wiki:</p>
      <pre><code>{{include(projectname:Foo)}}</code></pre></dd>

      <dt><code>collapse</code></dt>
255 256 257 258
      <dd><p>Vloží sbalený blok textu. Např.:</p>
      <pre><code>{{collapse(Zobrazit detaily...)
Toto je blok textu, který je sbalený.
Pro rozbalení klikněte na odkaz.
259 260 261
}}</code></pre></dd>

      <dt><code>thumbnail</code></dt>
262
      <dd><p>Zobrazí klikací náhled obrázku. Např.:</p>
263 264 265 266 267
      <pre>{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
    </dl>
    </p>

268
    <h2><a name="13" class="wiki-page"></a>Zvýrazňování kódu</h2>
269

270
    <p>Výchozí zvýrazňování kódu zavisí na <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, což je rychlá zvýrazňovací knihovna napsaná v Ruby. It currently supports c, clojure, cpp (c++, cplusplus), css, delphi (pascal), diff (patch), erb (eruby, rhtml), go, groovy, haml, html (xhtml), java, javascript (ecmascript, ecma_script, java_script, js), json, lua, php, python, ruby (irb), sass, sql, taskpaper, text (plain, plaintext), xml and yaml (yml) languages, where the names inside parentheses are aliases.</p>
271

272
    <p>Kód můžete na stránce zvýraznit pomocí následující syntaxe (note that the language name or alias is case-insensitive):</p>
273 274 275

<pre>
~~~ ruby
276
  Váš kód vložte zde.
277 278 279
~~~
</pre>

280
    <p>Např:</p>
281

282 283 284 285 286 287 288 289 290 291
<pre><code class="ruby syntaxhl"><span class="CodeRay"><span class="comment"># The Greeter class</span>
<span class="keyword">class</span> <span class="class">Greeter</span>
  <span class="keyword">def</span> <span class="function">initialize</span>(name)
    <span class="instance-variable">@name</span> = name.capitalize
  <span class="keyword">end</span>

  <span class="keyword">def</span> <span class="function">salute</span>
    puts <span class="string"><span class="delimiter">"</span><span class="content">Hello </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">!</span><span class="delimiter">"</span></span>
  <span class="keyword">end</span>
<span class="keyword">end</span></span></code>
292 293 294
</pre>
</body>
</html>