<!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=ca3aba42"> <link rel="stylesheet" href="../../../static/pygments.css"> <link rel="shortcut icon" href="../../../static/favicon.png?h=fa09bedd"> <title>Data Bags | 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</a> <ul> <li><a href="../alts/">Alternatives</a> <li><a href="../attachments/">Attachments</a> <li class="active"><a href="./">Data Bags</a> <ul></ul> <li><a href="../flow/">Flow</a> <li><a href="../paths/">Paths</a> <li><a href="../system-fields/">System Fields</a> <li><a href="../urls/">URLs and Slugs</a> </ul> <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/">API</a> <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="#creating-bags">Creating Bags</a></li> <li><a href="#nested-access">Nested Access</a></li> </ul> </div> </div> <div class="col-sm-9 doc-styling"> <h1>Data Bags</h1> <ul class=page-meta> </ul> <p>The <a href="../../api/databags/" class="ref">Data Bags</a> are a quick way to store structured information that templates can access. It's just a convenient way to access data from INI or JSON files. This is useful for instance to build a navigation menu or similar things.</p> <h2 id="creating-bags">Creating Bags</h2><p>To create a data bag just place a <code>.ini</code> or <code>.json</code> file in the <code>databags/</code> folder. The files there are accessible by their name sans the file extension. All ordering in the source files is retained. So for instance this could be the <code>main-nav.ini</code> data file for a basic navigation:</p> <div class="hll"><pre><span></span><span class="na">/downloads</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">Download</span><span class="w"></span> <span class="na">/docs</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">Documentation</span><span class="w"></span> <span class="na">/blog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">Blog</span><span class="w"></span> </pre></div> <p>And the template could access it like this:</p> <div class="hll"><pre><span></span><span class="p"><</span><span class="nt">ul</span> <span class="na">class</span><span class="o">=</span><span class="s">"nav"</span><span class="p">></span> <span class="cp">{%</span> <span class="k">for</span> <span class="nv">path</span><span class="o">,</span> <span class="nv">label</span> <span class="k">in</span> <span class="nv">bag</span><span class="o">(</span><span class="s1">'main-nav'</span><span class="o">)</span><span class="nv">.items</span><span class="o">()</span> <span class="cp">%}</span> <span class="p"><</span><span class="nt">li</span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">this.is_child_of</span><span class="o">(</span><span class="nv">path</span><span class="o">)</span> <span class="cp">%}</span> <span class="na">class</span><span class="o">=</span><span class="s">"active"</span><span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span><span class="p">><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">path</span><span class="o">|</span><span class="nf">url</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></span><span class="cp">{{</span> <span class="nv">label</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">a</span><span class="p">></span> <span class="p"></</span><span class="nt">li</span><span class="p">></span> <span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span> <span class="p"></</span><span class="nt">ul</span><span class="p">></span> </pre></div> <h2 id="nested-access">Nested Access</h2><p>Data bags can be structured in more complex ways. For INI files sections can be used, for JSON files entire object trees can be stored. The <a href="../../api/templates/globals/bag/" class="ref">bag</a> function can thus accept arbitrary dotted path (or multiple args to <code>bag</code>) to navigate to specific items within the bag. For instance you could use this to look up values that might change depending on the alternative of a page for instance.</p> <p>In this case the system is used to translate buttons. Take <code>buttons.ini</code> as an example:</p> <div class="hll"><pre><span></span><span class="k">[en]</span><span class="w"></span> <span class="na">download</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">Download</span><span class="w"></span> <span class="k">[de]</span><span class="w"></span> <span class="na">download</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">Herunterladen</span><span class="w"></span> <span class="k">[ru]</span><span class="w"></span> <span class="na">download</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">Скачать</span><span class="w"></span> </pre></div> <p>And in a template it could be used like this:</p> <div class="hll"><pre><span></span><span class="p"><</span><span class="nt">h2</span><span class="p">></span><span class="cp">{{</span> <span class="nv">bag</span><span class="o">(</span><span class="s1">'buttons'</span><span class="o">,</span> <span class="nv">this.alt</span><span class="o">,</span> <span class="s1">'download'</span><span class="o">)</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">h2</span><span class="p">></span> </pre></div> <div class="comment-box"> <h2>Comments</h2> <div id="disqus_thread"></div> <script> var disqus_config = function() { this.page.identifier = "/docs/content/databags"; this.page.url = "https://www.getlektor.com/docs/content/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/content/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> <script type=text/javascript src="../../../static/app.js?h=bb1b933a" 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>