1 line
No EOL
4.5 KiB
HTML
1 line
No EOL
4.5 KiB
HTML
<!DOCTYPE HTML><html><head><meta charset="UTF-8"><title>NML | References</title><link rel="stylesheet" href="../style.css"></head><body><div class="layout"><input id="navbar-checkbox" class="toggle" type="checkbox" style="display:none" checked><div id="navbar"><ul><li class="navbar-entry"><a href="Getting Started.html">Getting Started</a></li><li class="navbar-entry"><a href="Sections.html">Sections</a></li><li class="navbar-entry"><a href="Variables.html">Variables</a></li><li class="navbar-entry-current"><a href="References.html">References</a></li><li class="navbar-entry"><a href="Imports.html">Imports</a></li><li class="navbar-entry"><a href="Raw.html">Raw</a></li><li class="navbar-entry"><a href="Comments.html">Comments</a></li><li><details><summary class="navbar-category">External Tools</summary><ul><li class="navbar-entry"><a href="Graphviz.html">Graphviz</a></li><li class="navbar-entry"><a href="LaTeX.html">LaTeX</a></li></ul></details></li><li><details><summary class="navbar-category">Blocks</summary><ul><li class="navbar-entry"><a href="Blockquotes.html">Blockquotes</a></li><li class="navbar-entry"><a href="Code.html">Code</a></li><li class="navbar-entry"><a href="Lists.html">Lists</a></li></ul></details></li><li><details><summary class="navbar-category">Lua</summary><ul><li class="navbar-entry"><a href="Lua Basics.html">Lua</a></li></ul></details></li><li><details><summary class="navbar-category">Styles</summary><ul><li class="navbar-entry"><a href="Basic Styles.html">Basic</a></li><li class="navbar-entry"><a href="Basic Layouts.html">Layouts</a></li><li class="navbar-entry"><a href="User-Defined Styles.html">User-Defined</a></li></ul></details></li></ul></div><label for="navbar-checkbox" class="navbar-checkbox-label">☰</label><div class="content"><div class="toc"><span>Table of Content</span><ol><li value="1"><a href="#Internal_references">Internal references</a></li><ol><li value="1"><a href="#Media_references">Media references</a></li></ol><li value="2"><a href="#External_references">External references</a></li><li value="3"><a href="#Properties">Properties</a></li></div><h1 id="Internal_references">1. Internal references <a class="section-link" href="#Internal_references">🔗 </a> </h1><p>Internal references allow you to create references to elements defined within the current document.</p><p>Reference the the current section: <a class="inline-code"><code><span style="color:#c0c5ce;">&{internal_reference}</span></code></a> → <a class="section-reference" href="#Internal_references">(Internal references)</a></p><h2 id="Media_references">1.1. Media references <a class="section-link" href="#Media_references">🔗 </a> </h2><div class="media"><div id="medium-1" class="medium"><video controls><source src="assets/flower.webm"></video><p class="medium-refname">(1) Flower</p></div></div><p>When you reference a medium from the current document, the reference can be hovered to show the referenced medium: <a class="medium-ref" href="#medium-1">(1)<video><source src="assets/flower.webm"></video></a>.</p><h1 id="External_references">1. External references <a class="section-link" href="#External_references">🔗 </a> </h1><p>You can reference elements from other documents by adding the document's name before the reference name (separated by a <a class="inline-code"><code><span style="color:#c0c5ce;">#</span></code></a>). The document name refers to the output file (as defined by the variable <em>compiler.output</em>) excluding the extension.</p><ul><li><a class="inline-code"><code><span style="color:#c0c5ce;">&{doc#ref}</span></code></a>: Finds reference named <em>ref</em> in document named <em>doc</em>.</li><li><a class="inline-code"><code><span style="color:#c0c5ce;">&{#ref}</span></code></a>: Finds reference named <em>ref</em> in all documents. Note that this will fail if there are multiple documents defining reference <em>ref</em>.</li></ul><p>For instance:</p><ul><li><a class="inline-code"><code><span style="color:#c0c5ce;">&{LaTeX#tex_env}[caption=LaTeX environment]</span></code></a> → <a href="LaTeX.html#LaTeX_environment">LaTeX environment</a></li><li><a class="inline-code"><code><span style="color:#c0c5ce;">&{#tex_env}[caption=LaTeX environment]</span></code></a> → <a href="LaTeX.html#LaTeX_environment">LaTeX environment</a></li></ul><h1 id="Properties">2. Properties <a class="section-link" href="#Properties">🔗 </a> </h1><ul><li><a class="inline-code"><code><span style="color:#c0c5ce;">caption</span></code></a> The display caption for the reference</li></ul><p></p></div></div></body></html> |