build based on b0a1c96

dev/bibliography/index.html

@@ -13,4 +13,4 @@
     )</code></pre><p>Select a part of a bibliography based on a given selection set of keys. If complementary is true, selection designates which entries will not be kept. By default, complementary is set to false.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.sort_bibliography!" href="#Bibliography.sort_bibliography!"><code>Bibliography.sort_bibliography!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">sort_bibliography!(
     bibliography::DataStructures.OrderedDict{String,Entry},
     sorting_rule::Symbol = :key
-    )</code></pre><p>Sorts the bibliography in place.</p><p>The sorting order can be set by specifying the <code>sorting_rule</code>. The sorting is implemented via <code>isless()</code> functions. For detailed insight have a look at the <code>isless()</code> implementation of Julia and <code>BibInternal.jl</code>.</p><p>Supported symbols for <code>sorting_rule</code> are:</p><ul><li><code>:key</code> <strong>(default)</strong>: sort by bibliography keys e.g. BibTeX keys or <code>:id</code></li><li>the sorting rules defined in <a href="#Bibliography.sorting_rules"><code>sorting_rules</code></a></li></ul><div class="admonition is-info"><header class="admonition-header">Note:</header><div class="admonition-body"><p>The sorting is not following explicitly bibliographic alphabetizing conventions. It follows standard comparator behaviour implied by the implemented <code>isless()</code> functions (string comparators).</p></div></div></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xcite-Tuple{Any}" href="#Bibliography.xcite-Tuple{Any}"><code>Bibliography.xcite</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xcite(entry)</code></pre><p>Format the BibTeX cite output of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xfile-Tuple{Any}" href="#Bibliography.xfile-Tuple{Any}"><code>Bibliography.xfile</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xfile(entry)</code></pre><p>Format the downloadable path of an <code>Entry</code> file for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xin-Tuple{Any}" href="#Bibliography.xin-Tuple{Any}"><code>Bibliography.xin</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xin(entry)</code></pre><p>Format the appears-<code>in</code> field of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xlabels-Tuple{Any}" href="#Bibliography.xlabels-Tuple{Any}"><code>Bibliography.xlabels</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xlabels(entry)</code></pre><p>Format the labels of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xlink-Tuple{Any}" href="#Bibliography.xlink-Tuple{Any}"><code>Bibliography.xlink</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xlink(entry)</code></pre><p>Format the download link of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xnames" href="#Bibliography.xnames"><code>Bibliography.xnames</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">xnames(entry, editors = false; names = :full)</code></pre><p>Format the name of an <code>Entry</code> for web export.</p><p><strong>Arguments:</strong></p><ul><li><code>entry</code>: an entry</li><li><code>editors</code>: <code>true</code> if the name describes editors</li><li><code>names</code>: :full (full names) or :last (last names + first name abbreviation)</li></ul></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xtitle-Tuple{Any}" href="#Bibliography.xtitle-Tuple{Any}"><code>Bibliography.xtitle</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xtitle(entry</code></pre><p>Format the title of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xyear-Tuple{Any}" href="#Bibliography.xyear-Tuple{Any}"><code>Bibliography.xyear</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xyear(entry)</code></pre><p>Format the year of an <code>Entry</code> for web export.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../pages/">« Pages</a><a class="docs-footer-nextpage" href="../public/">Public »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Friday 27 January 2023 08:37">Friday 27 January 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+    )</code></pre><p>Sorts the bibliography in place.</p><p>The sorting order can be set by specifying the <code>sorting_rule</code>. The sorting is implemented via <code>isless()</code> functions. For detailed insight have a look at the <code>isless()</code> implementation of Julia and <code>BibInternal.jl</code>.</p><p>Supported symbols for <code>sorting_rule</code> are:</p><ul><li><code>:key</code> <strong>(default)</strong>: sort by bibliography keys e.g. BibTeX keys or <code>:id</code></li><li>the sorting rules defined in <a href="#Bibliography.sorting_rules"><code>sorting_rules</code></a></li></ul><div class="admonition is-info"><header class="admonition-header">Note:</header><div class="admonition-body"><p>The sorting is not following explicitly bibliographic alphabetizing conventions. It follows standard comparator behaviour implied by the implemented <code>isless()</code> functions (string comparators).</p></div></div></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xcite-Tuple{Any}" href="#Bibliography.xcite-Tuple{Any}"><code>Bibliography.xcite</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xcite(entry)</code></pre><p>Format the BibTeX cite output of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xfile-Tuple{Any}" href="#Bibliography.xfile-Tuple{Any}"><code>Bibliography.xfile</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xfile(entry)</code></pre><p>Format the downloadable path of an <code>Entry</code> file for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xin-Tuple{Any}" href="#Bibliography.xin-Tuple{Any}"><code>Bibliography.xin</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xin(entry)</code></pre><p>Format the appears-<code>in</code> field of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xlabels-Tuple{Any}" href="#Bibliography.xlabels-Tuple{Any}"><code>Bibliography.xlabels</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xlabels(entry)</code></pre><p>Format the labels of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xlink-Tuple{Any}" href="#Bibliography.xlink-Tuple{Any}"><code>Bibliography.xlink</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xlink(entry)</code></pre><p>Format the download link of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xnames" href="#Bibliography.xnames"><code>Bibliography.xnames</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">xnames(entry, editors = false; names = :full)</code></pre><p>Format the name of an <code>Entry</code> for web export.</p><p><strong>Arguments:</strong></p><ul><li><code>entry</code>: an entry</li><li><code>editors</code>: <code>true</code> if the name describes editors</li><li><code>names</code>: :full (full names) or :last (last names + first name abbreviation)</li></ul></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xtitle-Tuple{Any}" href="#Bibliography.xtitle-Tuple{Any}"><code>Bibliography.xtitle</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xtitle(entry</code></pre><p>Format the title of an <code>Entry</code> for web export.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Bibliography.xyear-Tuple{Any}" href="#Bibliography.xyear-Tuple{Any}"><code>Bibliography.xyear</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">xyear(entry)</code></pre><p>Format the year of an <code>Entry</code> for web export.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../pages/">« Pages</a><a class="docs-footer-nextpage" href="../public/">Public »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Monday 30 January 2023 03:21">Monday 30 January 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -65,4 +65,4 @@
             items=Publications("publications.bib")
         )
     ]
-)</code></pre><h3 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h3><p>This software is under the GPLv2 license.</p><p>The main theme, and some items (<code>BibTeX</code>, <code>Card</code>, <code>TimeLine</code>) are inspired by the Word Press Faculty template of owwwlab, also under GPLv2. All elements inspired from that template can be found in the HTML/CSS code associated with those items.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="themes/">Theming »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Friday 27 January 2023 08:37">Friday 27 January 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+)</code></pre><h3 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h3><p>This software is under the GPLv2 license.</p><p>The main theme, and some items (<code>BibTeX</code>, <code>Card</code>, <code>TimeLine</code>) are inspired by the Word Press Faculty template of owwwlab, also under GPLv2. All elements inspired from that template can be found in the HTML/CSS code associated with those items.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="themes/">Theming »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Monday 30 January 2023 03:21">Monday 30 January 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>