lektor-website/docs/api/db/system-fields/index.html

449 lines
13 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>System Fields | 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><a href="../../databags/">Databags</a>
<li><a href="../">Database</a>
<ul>
<li><a href="../asset/">Asset</a>
<li><a href="../types/">Builtin Field Types</a>
<li><a href="../expression/">Expression</a>
<li><a href="../f/">F</a>
<li><a href="../get-alts/">get_alts()</a>
<li><a href="../pad/">Pad</a>
<li><a href="../query/">Query</a>
<li><a href="../record/">Record</a>
<li><a href="../obj/">SourceObject</a>
<li class="active"><a href="./">System Fields</a>
<ul>
<li><a href="alt/">_alt</a>
<li><a href="attachment-type/">_attachment_type</a>
<li><a href="discoverable/">_discoverable</a>
<li><a href="gid/">_gid</a>
<li><a href="hidden/">_hidden</a>
<li><a href="id/">_id</a>
<li><a href="model/">_model</a>
<li><a href="path/">_path</a>
<li><a href="slug/">_slug</a>
<li><a href="source-alt/">_source_alt</a>
<li><a href="template/">_template</a>
</ul>
<li><a href="../type/">Type</a>
</ul>
<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>
<div class="col-sm-9 doc-styling">
<h1>System Fields</h1>
<ul class=page-meta>
</ul>
<p>All records have a few system fields available in addition to the fields
defined by the data model. These fields are always there and control internal
behavior in Lektor. They are prefixed by an underscore to separate them
from the fields a model defines.</p>
<p>Many system fields are hidden from the admin panel but some can be changed
there (<code>_template</code>, <code>_hidden</code>, and a few others).</p>
<div class="child-pages nocontent">
<div class="row">
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="alt/">_alt</a>
</h4>
<p class="summary">The alt for this record.</p>
</div>
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="attachment-type/">_attachment_type</a>
</h4>
<p class="summary">An indication of the attachment type.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="discoverable/">_discoverable</a>
</h4>
<p class="summary">Controls if this page is picked up by collection queries by default.</p>
</div>
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="gid/">_gid</a>
</h4>
<p class="summary">A globally unique ID of the page.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="hidden/">_hidden</a>
</h4>
<p class="summary">Controls if the page should be built or not.</p>
</div>
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="id/">_id</a>
</h4>
<p class="summary">The local identifier of a record.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="model/">_model</a>
</h4>
<p class="summary">The model the record uses for its fields.</p>
</div>
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="path/">_path</a>
</h4>
<p class="summary">The full path of the record.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="slug/">_slug</a>
</h4>
<p class="summary">The URL slug of the record.</p>
</div>
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="source-alt/">_source_alt</a>
</h4>
<p class="summary">The alt from the source of the record.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 child">
<h4>
<i class="glyphicon glyphicon-pencil"></i>
<a href="template/">_template</a>
</h4>
<p class="summary">Selects the template for the page.</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/db/system-fields"; this.page.url = "https://www.getlektor.com/docs/api/db/system-fields/"; };
(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/db/system-fields/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=dcf26092" 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>