Websites
/
lektor-website
mirror of https://github.com/lektor/lektor-website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
lektor-website/docs/api/databags/index.html

331 lines
12 KiB
HTML
Raw Normal View History

Synchronized build
2022-02-20 15:15:38 +01:00
<!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">
Synchronized build
2022-12-17 10:12:40 +01:00
<link rel="stylesheet" href="../../../static/styles.css?h=dff0aaad">
Synchronized build
2022-02-20 15:15:38 +01:00
<link rel="stylesheet" href="../../../static/pygments.css">
<link rel="shortcut icon" href="../../../static/favicon.png?h=fa09bedd">
<title>Databags | Documentation | 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 class="active"><a href="../../">Documentation</a></li>
<li><a href="../../../showcase/">Showcase</a></li>
<li><a href="../../../plugins/">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="container">
<div class="row">
<div class="col-sm-3">
<ul class="tree-nav nocontent">
<li><a href="../../">Welcome</a></li>
<li><a href="../../what/">What is Lektor</a>
<li><a href="../../installation/">Installation</a>
<li><a href="../../quickstart/">Quickstart</a>
<li><a href="../../project/">Project</a>
<li><a href="../../content/">Content</a>
<li><a href="../../templates/">Templates</a>
<li><a href="../../themes/">Themes</a>
<li><a href="../../guides/">Guides</a>
<li><a href="../../deployment/">Deployment</a>
<li><a href="../../plugins/">Plugins</a>
<li><a href="../../models/">Data Modelling</a>
<li><a href="../../cli/">Command Line</a>
<li><a href="../">API</a>
<ul>
<li><a href="../build/">Build System</a>
<li class="active"><a href="./">Databags</a>
<ul>
<li><a href="get-bag/">get_bag()</a>
<li><a href="lookup/">lookup()</a>
</ul>
<li><a href="../db/">Database</a>
<li><a href="../environment/">Environment</a>
<li><a href="../plugins/">Plugins</a>
<li><a href="../project/">Project</a>
<li><a href="../publisher/">Publisher</a>
<li><a href="../templates/">Template API</a>
<li><a href="../utils/">Utilities</a>
</ul>
<li><a href="../../search/">Search</a>
</ul>
<div class="visible-md-block visible-lg-block">
<h4>This Page</h4>
<ul class="toc">
<li><a href="#supported-formats">Supported Formats</a></li>
<li><a href="#navigating-bags">Navigating Bags</a></li>
<li><a href="#example-databag">Example Databag</a></li>
</ul>
</div>
</div>
<div class="col-sm-9 doc-styling">
<h1><i class="glyphicon glyphicon-leaf"></i> <code class="mod">lektor.databags.</code><code class="obj">Databags</code></h1>
<ul class=page-meta>
</ul>
<p>The databag system is a simple support system in Lektor that allows a
Lektor website to load variables from simple key/value or JSON files.
This is primarily useful to load translations, API keys and similar
things that are needed in multiple templates.</p>
<p>From within templates you can use the <a href="../templates/globals/bag/" class="ref">bag</a>
function to access databags.</p>
<h2 id="supported-formats">Supported Formats</h2><p>Databags go into the <code>databags/</code> folder in your project. There are two
formats supported: key/value pairs as ini files as well as JSON files:</p>
<table>
<thead><tr>
<th>Extension</th>
<th>Format</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>.json</code></td>
<td>JSON</td>
</tr>
<tr>
<td><code>.ini</code></td>
<td>INI Files with or without sections</td>
</tr>
</tbody>
</table>
<h2 id="navigating-bags">Navigating Bags</h2><p>Dotted notation is used to navigate into data bags which are globally
merged together. This means that if you have a file named <code>i18n.ini</code>
with a section <code>[en]</code> and a key <code>CLICK_HERE</code> the path <code>i18n.en.CLICK_HERE</code>
will target that key. For JSON files further nesting is possible. You
can also just target a section and the return value will be a dictionary
which can for instance be used with the <a href="../templates/filters/tojson/" class="ref">tojson</a>
filter.</p>
<h2 id="example-databag">Example Databag</h2><p>This is a basic example of a data bag that contains configuration values
for google maps. It's stored in <code>databags/gmaps.ini</code>:</p>
Synchronized build
2023-01-02 03:39:06 +01:00
<div class="hll"><pre><span></span><span class="na">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">1233456ABCDEFG</span>
<span class="na">api_url</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">https://www.google.com/maps/embed/v1/</span>
Synchronized build
2022-02-20 15:15:38 +01:00
</pre></div>
Synchronized build
2023-05-15 19:53:38 +02:00
<p>This can then be used to good effect in templates:</p>
Synchronized build
2022-05-03 00:53:59 +02:00
<div class="hll"><pre><span></span><span class="cp">{%</span> <span class="k">macro</span> <span class="nv">render_map</span><span class="o">(</span><span class="nv">location</span><span class="o">,</span> <span class="nv">width</span><span class="o">=</span><span class="m">600</span><span class="o">,</span> <span class="nv">height</span><span class="o">=</span><span class="m">450</span><span class="o">)</span> <span class="cp">%}</span>
Synchronized build
2022-02-20 15:15:38 +01:00
<span class="p">&lt;</span><span class="nt">iframe</span>
<span class="na">width</span><span class="o">=</span><span class="s">&quot;</span><span class="cp">{{</span> <span class="nv">width</span> <span class="cp">}}</span><span class="s">&quot;</span> <span class="na">height</span><span class="o">=</span><span class="s">&quot;</span><span class="cp">{{</span> <span class="nv">height</span> <span class="cp">}}</span><span class="s">&quot;</span>
<span class="na">frameborder</span><span class="o">=</span><span class="s">&quot;0&quot;</span> <span class="na">style</span><span class="o">=</span><span class="s">&quot;border:0&quot;</span>
<span class="na">src</span><span class="o">=</span><span class="s">&quot;</span><span class="cp">{{</span> <span class="nv">bag</span><span class="o">(</span><span class="s1">&#39;gmaps.api_url&#39;</span><span class="o">)</span> <span class="cp">}}</span><span class="s">?q=</span><span class="cp">{{</span> <span class="nv">location</span><span class="o">|</span><span class="nf">urlencode</span>
<span class="cp">}}</span><span class="s">&amp;key=</span><span class="cp">{{</span> <span class="nv">bag</span><span class="o">(</span><span class="s1">&#39;gmaps.key&#39;</span><span class="o">)|</span><span class="nf">urlencode</span> <span class="cp">}}</span><span class="s">&quot;</span>
<span class="na">allowfullscreen</span><span class="p">&gt;&lt;/</span><span class="nt">iframe</span><span class="p">&gt;</span>
<span class="cp">{%</span> <span class="k">endmacro</span> <span class="cp">%}</span>
</pre></div>
<div class="child-pages nocontent">
<div class="row">
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-cog"></i>
<a href="get-bag/">get_bag()</a>
</h4>
<p class="summary">Looks up an entire databag by its name.</p>
</div>
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-cog"></i>
<a href="lookup/">lookup()</a>
</h4>
<p class="summary">Looks up data from databags.</p>
</div>
</div>
</div>
<div class="comment-box">
<h2>Comments</h2>
<div id="disqus_thread"></div>
<script>
var disqus_config = function() { this.page.identifier = "/docs/api/databags"; this.page.url = "https://www.getlektor.com/docs/api/databags/"; };
(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 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/docs/api/databags/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>
Synchronized build
2022-12-20 07:58:42 +01:00
<script type=text/javascript src="../../../static/app.js?h=396519c0" charset="utf-8"></script>
Synchronized build
2022-02-20 15:15:38 +01:00
<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>