Debian Codegraph @

markdown/docs/help.html

raw
1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6 <meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
7 <title>Markdown</title>
8 <style type="text/css">
9
10 /*
11 :Author: David Goodger ([email protected])
12 :Id: $Id: html4css1.css 7056 2011-06-17 10:50:48Z milde $
13 :Copyright: This stylesheet has been placed in the public domain.
14
15 Default cascading style sheet for the HTML output of Docutils.
16
17 See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
18 customize this style sheet.
19 */
20
21 /* used to remove borders from tables and images */
22 .borderless, table.borderless td, table.borderless th {
23 border: 0 }
24
25 table.borderless td, table.borderless th {
26 /* Override padding for "table.docutils td" with "! important".
27 The right padding separates the table cells. */
28 padding: 0 0.5em 0 0 ! important }
29
30 .first {
31 /* Override more specific margin styles with "! important". */
32 margin-top: 0 ! important }
33
34 .last, .with-subtitle {
35 margin-bottom: 0 ! important }
36
37 .hidden {
38 display: none }
39
40 a.toc-backref {
41 text-decoration: none ;
42 color: black }
43
44 blockquote.epigraph {
45 margin: 2em 5em ; }
46
47 dl.docutils dd {
48 margin-bottom: 0.5em }
49
50 object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
51 overflow: hidden;
52 }
53
54 /* Uncomment (and remove this text!) to get bold-faced definition list terms
55 dl.docutils dt {
56 font-weight: bold }
57 */
58
59 div.abstract {
60 margin: 2em 5em }
61
62 div.abstract p.topic-title {
63 font-weight: bold ;
64 text-align: center }
65
66 div.admonition, div.attention, div.caution, div.danger, div.error,
67 div.hint, div.important, div.note, div.tip, div.warning {
68 margin: 2em ;
69 border: medium outset ;
70 padding: 1em }
71
72 div.admonition p.admonition-title, div.hint p.admonition-title,
73 div.important p.admonition-title, div.note p.admonition-title,
74 div.tip p.admonition-title {
75 font-weight: bold ;
76 font-family: sans-serif }
77
78 div.attention p.admonition-title, div.caution p.admonition-title,
79 div.danger p.admonition-title, div.error p.admonition-title,
80 div.warning p.admonition-title {
81 color: red ;
82 font-weight: bold ;
83 font-family: sans-serif }
84
85 /* Uncomment (and remove this text!) to get reduced vertical space in
86 compound paragraphs.
87 div.compound .compound-first, div.compound .compound-middle {
88 margin-bottom: 0.5em }
89
90 div.compound .compound-last, div.compound .compound-middle {
91 margin-top: 0.5em }
92 */
93
94 div.dedication {
95 margin: 2em 5em ;
96 text-align: center ;
97 font-style: italic }
98
99 div.dedication p.topic-title {
100 font-weight: bold ;
101 font-style: normal }
102
103 div.figure {
104 margin-left: 2em ;
105 margin-right: 2em }
106
107 div.footer, div.header {
108 clear: both;
109 font-size: smaller }
110
111 div.line-block {
112 display: block ;
113 margin-top: 1em ;
114 margin-bottom: 1em }
115
116 div.line-block div.line-block {
117 margin-top: 0 ;
118 margin-bottom: 0 ;
119 margin-left: 1.5em }
120
121 div.sidebar {
122 margin: 0 0 0.5em 1em ;
123 border: medium outset ;
124 padding: 1em ;
125 background-color: #ffffee ;
126 width: 40% ;
127 float: right ;
128 clear: right }
129
130 div.sidebar p.rubric {
131 font-family: sans-serif ;
132 font-size: medium }
133
134 div.system-messages {
135 margin: 5em }
136
137 div.system-messages h1 {
138 color: red }
139
140 div.system-message {
141 border: medium outset ;
142 padding: 1em }
143
144 div.system-message p.system-message-title {
145 color: red ;
146 font-weight: bold }
147
148 div.topic {
149 margin: 2em }
150
151 h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
152 h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
153 margin-top: 0.4em }
154
155 h1.title {
156 text-align: center }
157
158 h2.subtitle {
159 text-align: center }
160
161 hr.docutils {
162 width: 75% }
163
164 img.align-left, .figure.align-left, object.align-left {
165 clear: left ;
166 float: left ;
167 margin-right: 1em }
168
169 img.align-right, .figure.align-right, object.align-right {
170 clear: right ;
171 float: right ;
172 margin-left: 1em }
173
174 img.align-center, .figure.align-center, object.align-center {
175 display: block;
176 margin-left: auto;
177 margin-right: auto;
178 }
179
180 .align-left {
181 text-align: left }
182
183 .align-center {
184 clear: both ;
185 text-align: center }
186
187 .align-right {
188 text-align: right }
189
190 /* reset inner alignment in figures */
191 div.align-right {
192 text-align: inherit }
193
194 /* div.align-center * { */
195 /* text-align: left } */
196
197 ol.simple, ul.simple {
198 margin-bottom: 1em }
199
200 ol.arabic {
201 list-style: decimal }
202
203 ol.loweralpha {
204 list-style: lower-alpha }
205
206 ol.upperalpha {
207 list-style: upper-alpha }
208
209 ol.lowerroman {
210 list-style: lower-roman }
211
212 ol.upperroman {
213 list-style: upper-roman }
214
215 p.attribution {
216 text-align: right ;
217 margin-left: 50% }
218
219 p.caption {
220 font-style: italic }
221
222 p.credits {
223 font-style: italic ;
224 font-size: smaller }
225
226 p.label {
227 white-space: nowrap }
228
229 p.rubric {
230 font-weight: bold ;
231 font-size: larger ;
232 color: maroon ;
233 text-align: center }
234
235 p.sidebar-title {
236 font-family: sans-serif ;
237 font-weight: bold ;
238 font-size: larger }
239
240 p.sidebar-subtitle {
241 font-family: sans-serif ;
242 font-weight: bold }
243
244 p.topic-title {
245 font-weight: bold }
246
247 pre.address {
248 margin-bottom: 0 ;
249 margin-top: 0 ;
250 font: inherit }
251
252 pre.literal-block, pre.doctest-block, pre.math {
253 margin-left: 2em ;
254 margin-right: 2em }
255
256 span.classifier {
257 font-family: sans-serif ;
258 font-style: oblique }
259
260 span.classifier-delimiter {
261 font-family: sans-serif ;
262 font-weight: bold }
263
264 span.interpreted {
265 font-family: sans-serif }
266
267 span.option {
268 white-space: nowrap }
269
270 span.pre {
271 white-space: pre }
272
273 span.problematic {
274 color: red }
275
276 span.section-subtitle {
277 /* font-size relative to parent (h1..h6 element) */
278 font-size: 80% }
279
280 table.citation {
281 border-left: solid 1px gray;
282 margin-left: 1px }
283
284 table.docinfo {
285 margin: 2em 4em }
286
287 table.docutils {
288 margin-top: 0.5em ;
289 margin-bottom: 0.5em }
290
291 table.footnote {
292 border-left: solid 1px black;
293 margin-left: 1px }
294
295 table.docutils td, table.docutils th,
296 table.docinfo td, table.docinfo th {
297 padding-left: 0.5em ;
298 padding-right: 0.5em ;
299 vertical-align: top }
300
301 table.docutils th.field-name, table.docinfo th.docinfo-name {
302 font-weight: bold ;
303 text-align: left ;
304 white-space: nowrap ;
305 padding-left: 0 }
306
307 h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
308 h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
309 font-size: 100% }
310
311 ul.auto-toc {
312 list-style-type: none }
313
314 </style>
315 </head>
316 <body>
317 <div class="document" id="markdown">
318 <h1 class="title">Markdown</h1>
319
320 <a class="reference external image-reference" href="plugin.png"><img alt="The Markdown plugin in action" class="align-center" src="plugin_small.png" /></a>
321 <div class="contents topic" id="contents">
322 <p class="topic-title first">Contents</p>
323 <ul class="simple">
324 <li><a class="reference internal" href="#about" id="id2">About</a></li>
325 <li><a class="reference internal" href="#features" id="id3">Features</a></li>
326 <li><a class="reference internal" href="#usage" id="id4">Usage</a><ul>
327 <li><a class="reference internal" href="#preferences" id="id5"><em>Preferences</em></a></li>
328 <li><a class="reference internal" href="#custom-templates" id="id6"><em>Custom Templates</em></a></li>
329 </ul>
330 </li>
331 <li><a class="reference internal" href="#requirements" id="id7">Requirements</a></li>
332 <li><a class="reference internal" href="#license" id="id8">License</a></li>
333 <li><a class="reference internal" href="#authors" id="id9">Authors</a></li>
334 <li><a class="reference internal" href="#contact" id="id10">Contact</a></li>
335 </ul>
336 </div>
337 <div class="section" id="about">
338 <h1><a class="toc-backref" href="#id2">About</a></h1>
339 <p>This plugin provides a real-time preview of rendered Markdown, that is,
340 <a class="reference external" href="http://daringfireball.net/projects/markdown">Markdown</a> converted to HTML
341 and inserted into an HTML template and loaded into a
342 <a class="reference external" href="http://www.webkit.org">WebKit</a> view.</p>
343 </div>
344 <div class="section" id="features">
345 <h1><a class="toc-backref" href="#id3">Features</a></h1>
346 <ul class="simple">
347 <li>Allows placing the preview in the sidebar or message window areas</li>
348 <li>Updates the preview on-the-fly as you type, automatically.</li>
349 <li>Allows simple customization of fonts and colours and complete control
350 with custom template files.</li>
351 </ul>
352 </div>
353 <div class="section" id="usage">
354 <h1><a class="toc-backref" href="#id4">Usage</a></h1>
355 <p>The preview is active by default for all documents with a Markdown filetype
356 set. To set a document's filetype, choose from the menus:</p>
357 <a class="reference external image-reference" href="set_filetype.png"><img alt="Choosing Document-&gt;Set Filetype-&gt;Markup Languages-&gt;Markdown source file" class="align-center" src="set_filetype.png" /></a>
358 <p>Other than that the operation should be fully automatic. Use the Plugin
359 Preferences mechanism to customize some settings as described below.</p>
360 <p>For more information on Markdown syntax, read the
361 <a class="reference external" href="http://daringfireball.net/projects/markdown/syntax">Markdown Syntax Documentation</a>.</p>
362 <div class="section" id="preferences">
363 <h2><a class="toc-backref" href="#id5"><em>Preferences</em></a></h2>
364 <a class="reference external image-reference" href="settings.png"><img alt="The Markdown plugin's preferences GUI" class="align-center" src="settings.png" /></a>
365 <p>Using Geany's normal Plugin Preferences mechanism, you can customize some
366 important settings related to the Markdown preview. The preferences dialog
367 allows changing the following settings:</p>
368 <table border="1" class="docutils">
369 <colgroup>
370 <col width="12%" />
371 <col width="88%" />
372 </colgroup>
373 <thead valign="bottom">
374 <tr><th class="head">Name</th>
375 <th class="head">Description</th>
376 </tr>
377 </thead>
378 <tbody valign="top">
379 <tr><td>Position</td>
380 <td>The area of Geany's UI to put the preview view, currently either
381 in the sidebar or message window (bottom) areas.</td>
382 </tr>
383 <tr><td>Font</td>
384 <td>The regular body font of the preview.</td>
385 </tr>
386 <tr><td>Code Font</td>
387 <td>The font to use for the code tags (monospaced) font of the preview.</td>
388 </tr>
389 <tr><td>BG Color</td>
390 <td>The preview's background color.</td>
391 </tr>
392 <tr><td>FG Color</td>
393 <td>The preview's foreground (text) color.</td>
394 </tr>
395 <tr><td>Template</td>
396 <td>The file containing the HTML template for the preview.</td>
397 </tr>
398 </tbody>
399 </table>
400 <p>There's two ways to access the Plugin settings, one is through the
401 Plugin Manager using the buttons highlighted below:</p>
402 <a class="reference external image-reference" href="plugin_mgr.png"><img alt="The Plugin Manager dialog showing the Help and Preferences buttons." class="align-center" src="plugin_mgr.png" /></a>
403 <p>Clicking the <tt class="docutils literal">Help</tt> button opens this document in HTML format in your web
404 browser. The other way to access the plugin's preferences is through the
405 <tt class="docutils literal">Edit</tt> menu as pictured below:</p>
406 <a class="reference external image-reference" href="plugin_prefs.png"><img alt="Accessing plugin preferences from the Edit menu." class="align-center" src="plugin_prefs.png" /></a>
407 </div>
408 <div class="section" id="custom-templates">
409 <h2><a class="toc-backref" href="#id6"><em>Custom Templates</em></a></h2>
410 <p>You can provide a custom HTML template file which contains the substitution
411 strings that get replaced at run-time. The following substitution strings
412 are available:</p>
413 <table border="1" class="docutils">
414 <colgroup>
415 <col width="37%" />
416 <col width="63%" />
417 </colgroup>
418 <thead valign="bottom">
419 <tr><th class="head">Substitution String</th>
420 <th class="head">Description</th>
421 </tr>
422 </thead>
423 <tbody valign="top">
424 <tr><td><tt class="docutils literal">&#64;&#64;markdown&#64;&#64;</tt></td>
425 <td>The most important substitution string and
426 gets replaced with the HTML generated from the
427 editor's Markdown buffer. Not having this one
428 in the template makes the plugin completely
429 useless.</td>
430 </tr>
431 <tr><td><tt class="docutils literal">&#64;&#64;font_name&#64;&#64;</tt></td>
432 <td>The normal font family.</td>
433 </tr>
434 <tr><td><tt class="docutils literal">&#64;&#64;code_font_name&#64;&#64;</tt></td>
435 <td>The code/monospace font family.</td>
436 </tr>
437 <tr><td><tt class="docutils literal">&#64;&#64;font_point_size&#64;&#64;</tt></td>
438 <td>The size in points of the normal font.</td>
439 </tr>
440 <tr><td><tt class="docutils literal">&#64;&#64;code_font_point_size&#64;&#64;</tt></td>
441 <td>The size in points of the code/monospace font.</td>
442 </tr>
443 <tr><td><tt class="docutils literal">&#64;&#64;bg_color&#64;&#64;</tt></td>
444 <td>The background color in hex/HTML color notation.</td>
445 </tr>
446 <tr><td><tt class="docutils literal">&#64;&#64;fg_color&#64;&#64;</tt></td>
447 <td>The foreground (text) color in hex/HTML color
448 notation.</td>
449 </tr>
450 </tbody>
451 </table>
452 <p>The default template file (at the time of writing) contains the following
453 HTML code:</p>
454 <pre class="literal-block">
455 &lt;html&gt;
456 &lt;head&gt;
457 &lt;style type=&quot;text/css&quot;&gt;
458 body {
459 font-family: &#64;&#64;font_name&#64;&#64;;
460 font-size: &#64;&#64;font_point_size&#64;&#64;pt;
461 background-color: &#64;&#64;bg_color&#64;&#64;;
462 color: &#64;&#64;fg_color&#64;&#64;;
463 }
464 code {
465 font-family: &#64;&#64;code_font_name&#64;&#64;;
466 font-size: &#64;&#64;code_font_point_size&#64;&#64;pt;
467 }
468 &lt;/style&gt;
469 &lt;/head&gt;
470 &lt;body&gt;
471 &#64;&#64;markdown&#64;&#64;
472 &lt;/body&gt;
473 &lt;/html&gt;
474 </pre>
475 <p>As you can see it's just normal HTML/CSS and you can tweak it to make the
476 preview contents look exactly how you want. The preview view is a WebKit
477 browser, the same one used by <a class="reference external" href="http://google.com/chrome">Google's Chrome Browser</a> and <a class="reference external" href="http://apple.com/safari">Apple's Safari Browser</a> as well as numerous others, and it supports many
478 modern features such as HTML5 and CSS3 support (at least partially).</p>
479 <p>If you mess up the default <tt class="docutils literal">template.html</tt> file, just delete it and the
480 default one will be recreated the next time the Markdown plugin is reloaded
481 (for example when Geany restarts).</p>
482 </div>
483 </div>
484 <div class="section" id="requirements">
485 <h1><a class="toc-backref" href="#id7">Requirements</a></h1>
486 <p>The plugin depends on the following libraries:</p>
487 <ul class="simple">
488 <li><a class="reference external" href="http://www.gtk.org">GTK+</a> 2.16 or greater</li>
489 <li><a class="reference external" href="http://webkitgtk.org">WebKitGTK+</a> 1.1.18 or greater</li>
490 </ul>
491 </div>
492 <div class="section" id="license">
493 <h1><a class="toc-backref" href="#id8">License</a></h1>
494 <p>The Markdown plugin is licensed under the GNU General Public License,
495 version 2. For the full text of the license, please visit
496 <a class="reference external" href="http://www.gnu.org/licenses/gpl-2.0.html">http://www.gnu.org/licenses/gpl-2.0.html</a>. The GPL license covers all code
497 and files <em>not</em> in the <tt class="docutils literal">discount</tt> directory.</p>
498 <p>All code inside the <tt class="docutils literal">discount</tt> directory is under a BSD-style license
499 (see the <tt class="docutils literal">discount/COPYRIGHT</tt> file) and all contributions to this code
500 <em>will</em> remain under this license. This will make it easier to integrate
501 improvements to Discount back upstream if it ever makes sense. So far the
502 only changes are superficial to allow it to build with the Geany-Plugins
503 build system and to prevent some compiler warnings.</p>
504 </div>
505 <div class="section" id="authors">
506 <h1><a class="toc-backref" href="#id9">Authors</a></h1>
507 <p>The Geany Markdown plugin is written and maintained by:</p>
508 <pre class="literal-block">
509 Matthew Brush &lt;matt(at)geany(dot)org&gt;
510 </pre>
511 <p>The plugin includes the Discount Markdown library, developed by:</p>
512 <pre class="literal-block">
513 David Loren Parsons &lt;http://www.pell.portland.or.us/~orc&gt;
514 </pre>
515 </div>
516 <div class="section" id="contact">
517 <h1><a class="toc-backref" href="#id10">Contact</a></h1>
518 <p>You can email me at <tt class="docutils literal">matt(at)geany(dot)org</tt>, or find me on the
519 <tt class="docutils literal">#geany</tt> IRC channel on FreeNode, with the nickname <tt class="docutils literal">codebrainz</tt>.</p>
520 </div>
521 </div>
522 </body>
523 </html>