all repos — h3rald @ a0608970a4faab23e4926c31188e7c579d2f15b3

The sources of https://h3rald.com

contents/glyph/book/macros/macros_inline.html

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 
-----
title: "Glyph – Inline Macros"
content-type: page
-----
<nav class="navigation"><a href="/glyph/book/macros/macros_block.html">← Block Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_filters.html">Filter Macros →</a></nav>
	
	<section class="section">
<header><h1 id="m_anchor" class="toc"><code>anchor</code></h1></header>
<p>Creates a named anchor (or bookmark).</p>
<strong>Aliases:</strong> <code>bookmark, #</code>
<p><strong>Example:</strong> <code>#[test|Test Bookmark]</code></p>



		<section class="section">
<header><h1 id="h_242" class="notoc">Parameters</h1></header>
<table style="width:100%;">
			<tr>
				<th style="width:30%">Parameter</th>
				<th>Description</th>
			</tr>
<tr>
			<td>0</td>
			<td>The identifier of the bookmark</td>
		</tr>
	
			
		<tr>
			<td>1</td>
			<td>The contents of the bookmark <em>(optional)</em></td>
		</tr>
		</table>

</section>

</section>
	

	
	<section class="section">
<header><h1 id="m_draftcomment" class="toc"><code>draftcomment</code></h1></header>
<p>If the <a href="/glyph/book/config/document.html#s_document_draft"><code>document.draft</code></a> setting is set to <code>true</code>, displays a draft comment within the document.</p>
<strong>Aliases:</strong> <code>dc</code>
<p><strong>Example:</strong> <code>dc[This is printed only in draft documents.]</code></p>



		<section class="section">
<header><h1 id="h_244" class="notoc">Parameters</h1></header>
<table style="width:100%;">
			<tr>
				<th style="width:30%">Parameter</th>
				<th>Description</th>
			</tr>
<tr>
			<td>0</td>
			<td>The text of the comment.</td>
		</tr>
		</table>

</section>

</section>
	

	
	<section class="section">
<header><h1 id="m_fmi" class="toc"><code>fmi</code></h1></header>
<p>Creates a <em>For More Information</em> link (for an example usage, see the <a href="#m_link"><code>link</code></a> macro).</p>

<p><strong>Example:</strong> <code>fmi[creating links|#links]</code></p>



		<section class="section">
<header><h1 id="h_246" class="notoc">Parameters</h1></header>
<table style="width:100%;">
			<tr>
				<th style="width:30%">Parameter</th>
				<th>Description</th>
			</tr>
<tr>
			<td>0</td>
			<td>The object that needs additional explanation.</td>
		</tr>
	
			
		<tr>
			<td>1</td>
			<td>A valid bookmark within the document.</td>
		</tr>
		</table>

</section>

</section>
	

	
	<section class="section">
<header><h1 id="m_link" class="toc"><code>link</code></h1></header>
<p>Creates an hyperlink (<span class="fmi">for more information on <mark>creating links</mark>, see <a href="/glyph/book/text_editing/links.html#links">Links and Bookmarks</a></span>).</p>
<strong>Aliases:</strong> <code>=></code>
<p><strong>Example:</strong> <code>=>[http://www.h3rald.com|H3RALD.com]</code></p>



		<section class="section">
<header><h1 id="h_248" class="notoc">Parameters</h1></header>
<table style="width:100%;">
			<tr>
				<th style="width:30%">Parameter</th>
				<th>Description</th>
			</tr>
<tr>
			<td>0</td>
			<td>A valid bookmark within the document or an URL.</td>
		</tr>
	
			
		<tr>
			<td>1</td>
			<td>The text of the link <em>(optional)</em>.</td>
		</tr>
		</table>

</section>

</section>
	

	
	<section class="section">
<header><h1 id="m_todo" class="toc"><code>todo</code></h1></header>
<p>Saves the value as a <span class="caps">TODO</span> item, which can be printed using the <a href="/glyph/book/ref_commands.html#c_todo"><code>todo</code></a> command and included in the document if the <a href="/glyph/book/config/document.html#s_document_draft"><code>document.draft</code></a> setting is set to <code>true</code>.</p>
<strong>Aliases:</strong> <code>!</code>
<p><strong>Example:</strong> <code>todo[Remember to do this.]</code></p>

</section>
	
<nav class="navigation"><a href="/glyph/book/macros/macros_block.html">← Block Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_filters.html">Filter Macros →</a></nav>