lektor-website/plugins/lektor-bibtex-support/index.html

265 lines
9.5 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<link rel="stylesheet" href="../../static/styles.css?h=dff0aaad">
<link rel="stylesheet" href="../../static/pygments.css">
<link rel="shortcut icon" href="../../static/favicon.png?h=fa09bedd">
<title> | Lektor Static Content Management System</title>
</head>
<body class="default">
<nav class="navbar navbar-inverse navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed"
data-toggle="collapse" data-target="#navbar"
aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../">Lektor</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../../downloads/">Download</a></li>
<li><a href="../../docs/">Documentation</a></li>
<li><a href="../../showcase/">Showcase</a></li>
<li class="active"><a href="../">Plugins</a></li>
<li><a href="../../community/">Community</a></li>
<li><a href="../../blog/">Blog</a></li>
</ul>
</div>
</div>
</nav>
<div class="body-wrapper">
<div class="page-banner page-banner-300" style="background-image: url(../header.jpg)"></div>
<div class="container">
<!-- Place this tag in your head or just before your close body tag. -->
<div class="plugin">
<div class="row">
<div class="col-sm-12">
<h1>Plugin &ndash; lektor-bibtex-support 0.1.1</h1>
</div>
</div>
<div class="row">
<div class="col-sm-1"></div>
<div class="col-sm-11">
<p>Bibtex file support to easily include publication lists.<p>
</div>
</div>
<div class="row">
<div class="col-sm-3 plugin-margin">
<h4>Project links</h4>
<ul class="tree-nav">
<li><a href="https://github.com/arunpersaud/lektor-bibtex-support" class="ext">Homepage</a></li>
</ul>
<div class="separator">
<h4>GitHub Statistics</h4>
</div>
<ul class="button-nav">
<li><p><a class="github-button" href="https://github.com/arunpersaud/lektor-bibtex-support" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star lektor-bibtex-support on GitHub" target="_blank">Star</a></p></li>
<li><p><a class="github-button" href="https://github.com/arunpersaud/lektor-bibtex-support/fork" data-icon="octicon-repo-forked" data-show-count="true" data-size="large" data-show="true" aria-label="Open Issues" target="_blank">Fork</a></p></li>
<li><p><a class="github-button" href="https://github.com/arunpersaud/lektor-bibtex-support/issues" data-icon="octicon-issue-opened" data-show-count="true" data-size="large" data-show="true" aria-label="Open Issues" target="_blank">Open Issues</a></p></li>
</ul>
<div class="separator">
<h4>Meta</h4>
</div>
<p><strong>Version:</strong> 0.1.1</p>
<p><strong>Author:</strong>
<a href="mailto:arun@nubati.net">Arun Persaud</a>
</p>
<div class="separator">
<h4>Tags</h4>
</div>
<a href="../tag/Jinja-globals/">Jinja globals</a>,
<a href="../tag/LaTeX/">LaTeX</a>,
and
<a href="../tag/setup-env/">setup-env</a>
<p>
View <a href="../tags/" class="ref">all tags</a>.
</p>
</div>
<div class="col-sm-9 doc-styling">
<h2>Project Description</h2>
<h1>Lektor Bibtex Plugin</h1>
<p>The plugin allows adding a list of publications generated from bibtex files to a page.</p>
<h2>Enabling the plugin</h2>
<p>To enable the plugin add this to your project file:</p>
<pre><code>[packages]
lektor-bibtex-support = 0.1
</code></pre>
<h2>Configuring</h2>
<p>Create a file configs/bibtex-support.ini with a section called Bibtex. Define a variable files that
is a white space separated list of bibtex files. Put these files into the assets directory of your project.</p>
<pre><code>[Bibtex]
files = A.bib B.bib
</code></pre>
<p>Optionally you can also create a template file that should leave in the template directory to render the bibtex entries. If you skip this entry a default template will be used that sorts the entries by year.</p>
<h2>Usage</h2>
<p>You can add the the publication anywhere in your jinja template by calling</p>
<pre><code>{{ list_publications(name=name, tag=tag, year=year, labels=labels, fname=fname)|safe }}
</code></pre>
<p>The arguments are optional and can be used for filtering.</p>
<p>By name: the name has to show up in the author list to be included</p>
<p>by year: only publications from this year</p>
<p>labels: white space separated list of bibtex labels (the name of each entry in the bibtex file)</p>
<p>fname: white space separated list files to search (by default all files will be searched)</p>
<h2>Javascript</h2>
<p>For the default template, you can also add the following javascript to show some entries if you have a long list (relies on jquery):</p>
<pre><code>$(document).ready(function()
{
$(&quot;.BIBTeX&quot;).hide();
$(&quot;.BIBTeXtoggle&quot;).click( function () {
$(this).parent().children(&quot;.BIBTeX&quot;).toggle(300);
return false;
});
$(&quot;.BIBYear&quot;).hide();
$(&quot;.BIBYear:first&quot;).show();
$(&quot;.BIBYearheader&quot;).click( function () {
$(this).parent().children(&quot;.BIBYear&quot;).toggle(300);
return false;
});
$(&quot;.bibshowall&quot;).click( function () {
$(&quot;.BIBYear&quot;).show();
});
$(&quot;.bibhideall&quot;).click( function () {
$(&quot;.BIBYear&quot;).hide();
$(&quot;.BIBYear:first&quot;).show();
});
});
</code></pre>
<div class="comment-box">
<h2>Comments</h2>
<div id="disqus_thread"></div>
<script>
var disqus_config = function() { this.page.identifier = "/plugins/lektor-bibtex-support"; this.page.url = "https://www.getlektor.com/plugins/lektor-bibtex-support/"; };
(function() {
var d = document, s = d.createElement('script');
s.src = '//lektordocumentation.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>
Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript"
rel="nofollow">comments powered by Disqus.</a>
</noscript>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="bottomsummary">
<div class="container">
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-4 icon-bar">
<a href="https://github.com/lektor/lektor/" title="Lektor on GitHub"
><i class="fa fa-github"></i></a>
<a href="https://github.com/lektor/lektor/issues/" title="Report Issues for Lektor"
><i class="fa fa-bug"></i></a>
<a href="https://twitter.com/getlektor" title="Find Lektor on Twitter"
><i class="fa fa-twitter"></i></a>
<a href="https://gitter.im/lektor/lektor" title="Chat on Gitter"
><i class="fa fa-comment"></i></a>
<a href="https://github.com/lektor/lektor-website/tree/master/content/plugins/lektor-bibtex-support/contents.lr" title="View source for this page"><i class="fa fa-code"></i></a>
</div>
<div class="col-sm-8">
<a href="../../license/">License & Copyright</a>
<a href="../../contact/">Contact</a>
Made with <i class="fa fa-fw fa-heart" title="Heart"><span hidden>Heart</span></i> in Carinthia
</div>
</div>
</div>
</footer>
<script type=text/javascript src="../../static/app.js?h=ee15141e" charset="utf-8"></script>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'lektor/lektor',
activationElement: null
};
document.write('<button class="js-gitter-toggle-chat-button">Toggle Chat</button>');
var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
if (dnt != "1" && dnt != "yes") {
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', 'UA-70822533-1', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
} else {
console.debug("Respecting Do-Not-Track, not running analytics.");
}
</script>
<script async src='https://www.google-analytics.com/analytics.js'></script>
<script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
</body>
</html>