autodoc.git
/
traditional_manual
/
chapter_21.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional_manual/chapter_21.html:54336:
</dt> <dd><p><code><code class='datatype'>string</code> <b><span class='method'>get_text</span>(</b><b>)</b></code></p></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns all the licenses as a string, suitable for saving as a file.</p> </dd></dl> </dd></dl></dd></dl><dl><dt><h2 class='header'>Module <b class='ms datatype'>Tools.Markdown</b></h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt>
-
<dd class='body--doc'><p>This is a
port
of
the
Javascript Markdown parser
-
<a href='https://github.com/chjj/marked Marked'>https://github.com/chjj/marked Marked</a>. The only method needed
to
-
be used is
<code>
parse()</code> which will transform Markdown text to HTML
.
</p>
-
<p> For a description on
Markdown
, go to the web page of the inventor of
-
Markdown
<
a href='https:
/
/daringfireball.net/projects/markdown/'>https://daringfireball.net/projects/markdown/</a>.</p>
-
</dd></dl>
-
-
<hr />
-
<dl class='group--doc'>
-
<dt class='head--type'><span class='homogen--type'>Method</span>
-
<span class='homogen--name'><b>encode_html</b></span>
-
</dt>
-
<dd><p><
code>
<code
class='modifier'>protected</code> <code class='datatype'>string</code> <b><span class='method'>encode_html</span>(</b><code class='datatype'>string</code> <code class='argument'>html</code>, <code class='datatype'>void</code>|<code class='object unresolved'>bool</code> <code class='argument'>enc</code><b>)</b></code></p></dd>
-
-
<dt class='head
-
-doc'>Description</dt>
-
<dd
class='body--doc'><p>HTML
encode <tt><>"'</tt>. If <code>enc</code>
is
<tt>true</tt> <tt>&</tt> will also be encoded</p>
-
</dd></dl>
-
-
-
<hr
/>
-
<dl
class='group--doc'>
-
<dt class='head--type'><span class='homogen--type'>Method</span>
-
<span class='homogen--name'><b>parse</b></span>
-
</dt>
-
<dd><p><code><code class='datatype'>string</code> <b><span class='method'>parse</span>(</b><code class='datatype'>string</code> <code class='argument'>md</code>, <code class='datatype'>void</code>|<code class='datatype'>mapping</code> <code class='argument'>options</code><b>)</b></code></p></dd>
-
-
<dt class='head--doc'>Description</dt>
-
<dd class='body--doc'><p>Convert markdown <code>md</code>
to
html</p>
-
</dd>
-
<dt
class='head--doc'>
<
span id='p-options'></span>Parameter <
code
class='parameter'
>
options</code></dt>
-
<dd></dd><dd class='body--doc'><table class='box'><tr><td><code><code class='key'>"gfm"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Enable Github Flavoured
Markdown.
(true)
</
p>
-
</td></tr>
-
<tr><td><
code>
<code class='key'>"tables"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Enable GFM tables. Requires "gfm"
(
true
)
</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"breaks"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Enable GFM "breaks"
.
Requires "gfm" (false)
</p>
-
</
td></tr>
-
<tr><td><code><code class='key'>"pedantic"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Conform to obscure parts of markdown.pl as much as possible.
-
Don't fix any of the original markdown bugs or poor behavior. (false)</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"sanitize"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Sanitize the output. Ignore any HTML that has been input. (false)</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"mangle"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Mangle (obfuscate) autolinked email addresses (true)</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"smart_lists"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Use smarter list behavior than the original markdown. (true)</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"smartypants"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Use "smart" typograhic punctuation for things like quotes and
-
dashes. (false)</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"header_prefix"</code> : <code class='datatype'>string</code></code></td><td><p>Add prefix to ID attributes of header tags (empty)</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"xhtml"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Generate self closing XHTML tags (false)</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"newline"</code> : <code class='object unresolved'>bool</code></code></td><td><p>Add a newline after tags. If false the output will be
-
on one line (well, newlines in text will be kept). (false)</p>
-
</td></tr>
-
<tr><td><code><code class='key'>"renderer"</code> : <code class='object unresolved'>Renderer</code></code></td><td><p>Use this renderer to render output. (Renderer)</p>
-
</td></tr>
-
</table>
-
</
dd></dl>
-
-
-
<
hr
/
>
-
<dl class='group--doc'>
-
<dt class='head--type'><span class='homogen--type'>Method</span>
-
<span class='homogen--name'><b>replace1</b></span>
-
</dt>
-
<
dd><
p><code><code class='modifier'>protected<
/
code> <code class='datatype'>string</code> <b><span class='method'>replace1</span>(</b><code class='datatype'>string</code> <code class='argument'>subject</code>, <code class='datatype'>string</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code><b>)</b></code></p></dd>
-
-
<dt class='head--doc'>Description</dt>
-
<dd class='body--doc'><p>Replaces the first occurance of <code>from</code> in <code>subject</code> to <code>to</code></p>
-
</dd></
dl>
-
<
/dd></
dl><
dl><
dt><h2 class='header'>Module <b class='ms datatype'>Tools.MasterHelp</b></h2>
+
<dd class='body--doc'><p>This is a
small
stub
entrypoint
to <code>
Parser
.Markdown</code> -
it
is
exactly
+
equivalent
to
calling
<code>
Parser.
Markdown.
parse
</code>().</p>
+
</dd></dl></dd></dl><dl><dt><h2 class='header'>Module <b class='ms datatype'>Tools.MasterHelp</b></h2>
</dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>This module contains usage strings for the <code>master()->_main()</code>.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>do_help</b></span> </dt>