@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
3 lines • 4.09 kB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Adding Bibliographical References — </title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-grimoire-128h_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="CiaoDevel.html">↑</a><a class="lpdoc-navbutton" href="NewRelease.html">←</a><a class="lpdoc-navbutton" href="CiaoDevelrefs.html">→</a><a class="lpdoc-navbutton" href="CiaoDevelsearch.html">🔍</a></span><span><a href="CiaoDevelfulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="CiaoDevel.html">CiaoDevel Reference Manual</a> »<br/> </li><li><a href=""><strong>Adding Bibliographical References</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Citations in documentation">Citations in documentation</a></li><li><a href="#Adding new bibtex entries">Adding new bibtex entries</a></li><li><a href="#Future improvements">Future improvements</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Adding Bibliographical References</h1><a class="lpdoc-idx-anchor" href="CiaoDevelsearch.html#CiaoBiblio"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="The Ciao Development Team" href="CiaoDevelsearch.html#The Ciao Development Team">The Ciao Development Team</a>.<p>
<div id="Citations in documentation"><h2>Citations in documentation</h2> LPdoc allows citing and referencing papers specified in one or more <tt>.bib</tt> files.<p>Please use citations for code that originated from (or was written together with) formal papers and technical reports. In such cases many details about the motivation, related work, design, technical details (and proofs) are not necessary within the source code documentation.<p>Nowadays it is preferable to write code that works (and that is straightforward to use for the target audience) over producing over-detailed documentation that mixes irrelevant (for the user) implementation details with usage. In cases where the technical information does not fit into a paper, please describe it in clearly identified sections or parts of the manual.<p></div><div id="Adding new bibtex entries"><h2>Adding new bibtex entries</h2> If you need to add new bibtex entries please proceed as follow:<p><ul> <li>add new entries to <tt>clip.bib</tt> or <tt>general.bib</tt> in the group's bibtex SVN repo (the same as for papers): </ul> <pre class="lpdoc-codeblock">svn+ssh://cliplab.org/home/clip/SvnReps/bibtex</pre> <ul> <li>generate the documentation (you should see some unresolved citations warnings) <li>use the <tt>update-common-bib.sh</tt> script (follow instructions) to update <tt>common.bib</tt> <li>review the changes and commit the updated <tt>common.bib</tt> file </ul> </div><div id="Future improvements"><h2>Future improvements</h2> Note that the instructions above may change in the future (e.g., we may generate a single .bib file for each bundle or move/integrate the script somewhere else).<p><ul> <li>Generate and use a .bib per bundle. <li>Integrate the script. This is a very specific feature that may not be very useful for other Ciao users. Perhaps it fits better into the helper helper programs used to generate distributions, publish to github, etc. <li>Parts of this functionality may fit into <tt>bibutils</tt> <li>Use (our) <tt>bibutils</tt> instead of (third-party) <tt>bibtool</tt> </ul> </div><br/></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>