tyto-litterateur/website_doc/article/metas_obligatoires.html

131 lines
6.8 KiB
HTML

<!-- Écrire les métadonnées indispensables - Tyto - Littérateur (page generated by Tyto - Littérateur) -->
<!DocType html>
<html lang="fr">
<head>
<!--# include virtual="/template/metas.html"-->
<!-- Metas/Links from domain and article -->
<meta name="generator" content="Tyto - Littérateur">
<!-- metas generated from domain -->
<meta name="url" content="https://tyto.echolib.re/">
<meta name="language" content="fr">
<meta name="reply-to" content="echolib+tyto@a-lec.org">
<meta name="copyright" content="gfdl-1.3">
<!-- metas generated from article -->
<meta name="title" content="Écrire les métadonnées indispensables">
<meta name="author" content="echolib">
<meta name="description" content="Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur">
<meta name="keywords" content="Tyto,littérateur,logiciel libre,documentation,format .tyto,écrire,métadonnées,entête">
<!-- metas links to template files -->
<link rel="canonical" href="https://tyto.echolib.re/article/metas_obligatoires.html">
<link rel="stylesheet" href="../template/styles.css">
<link rel="shortcut icon" type="image/png" href="../template/favicon.png">
<link rel="alternate" type="application/rss+xml" href="../rss.xml" title="RSS 2.0 Tyto - Littérateur">
<!-- Open Graph data -->
<meta property="og:site_name" content="Tyto - Littérateur">
<meta property="og:title" content="Écrire les métadonnées indispensables">
<meta property="og:type" content="article">
<meta property="og:url" content="https://tyto.echolib.re/article/metas_obligatoires.html">
<meta property="og:description" content="Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur">
<meta property="og:image" content="https://tyto.echolib.re/images/logos/tyto_5_metas.png">
<!-- Publication date and title -->
<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date">
<title>Écrire les métadonnées indispensables (echolib) | Tyto - Littérateur</title>
</head>
<body>
<div id="site_container">
<!--# include virtual="/template/header.html"-->
<!--# include virtual="/template/navbar.html"-->
<main id="article_sidebar"> <!-- Contains <article> and <aside> -->
<article id="article">
<time datetime="2024-01-15 18:28:34">
<header id="article_header">
<img id="article_logo" src="https://tyto.echolib.re/images/logos/tyto_5_metas.png" alt="Écrire les métadonnées indispensables">
<h1 role="heading" aria-level="1" id="article_title">
<a role="link" id="article_title_link" href="https://tyto.echolib.re/article/metas_obligatoires.html" title="Écrire les métadonnées indispensables -- echolib, 06/01/2024">Écrire les métadonnées indispensables</a>
</h1>
<div id="article_refs">
echolib, 06/01/2024 [<a id="post_code" class="tyto" href="./metas_obligatoires.tyto" title="Code source : Écrire les métadonnées indispensables">Code source</a>]
</div>
</header>
<h2 role="heading" aria-level="2" class="toc_title">Table des matières</h2>
<nav role="navigation" class="toc" aria-labelledby="navigation-0">
<ul role="list" class="toc_items">
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_1">Les 5 marqueurs obligatoires</a></li>
<ul>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_2">Configurer les marqueurs</a></li>
<ul>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_3">Le titre de l'article</a></li>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_4">La date de l'article</a></li>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_5">Les étiquettes de l'article</a></li>
</ul>
</ul>
</ul>
</nav>
<h2 role="heading" aria-level="2" id="toc_1" class="tyto">Les 5 marqueurs obligatoires</h2>
<p class="tyto">
Ces marqueurs et leurs métadonnées sont indispensables. <cite class="tyto">Tyto</cite> en a besoin,
afin de les reprendre, notamment dans les balises HTML <code class="tyto">&lt;meta&gt;</code>. Chacun
de ces marqueur doit être <strong class="tyto">écrit sur une seule ligne</strong>. Leur ordre est
aléatoire. Vous pouvez indenter leurs contenus pour une meilleure
lisibilité. Comme toutes métadonnées d'entête, elles doivent être
écrites au dessus du séparateur <code class="tyto">-----</code>. Vous pouvez également utiliser
des commentaires (la ligne comence par <code class="tyto">#</code>)
</p>
<h3 role="heading" aria-level="3" id="toc_2" class="tyto">Configurer les marqueurs</h3>
<pre class="bcode_pre">
<ol class="bcode_items">
<li role="listitem" class="bcode_item"><code class="bcode_code"># Marqueur: Contenus</code></li>
<li role="listitem" class="bcode_item"><code class="bcode_code"></code></li>
<li role="listitem" class="bcode_item"><code class="bcode_code">title: Le titre de l&apos;article</code></li>
<li role="listitem" class="bcode_item"><code class="bcode_code">about: La description de l&apos;article</code></li>
<li role="listitem" class="bcode_item"><code class="bcode_code">date: La date de l&apos;article (AAAA-MM-JJ)</code></li>
<li role="listitem" class="bcode_item"><code class="bcode_code">tags: étiquette,mots clés,</code></li>
<li role="listitem" class="bcode_item"><code class="bcode_code">authors: Auteur 1,Auteur 2</code></li>
</ol></pre>
<h4 role="heading" aria-level="4" id="toc_3" class="tyto">Le titre de l'article</h4>
<p class="tyto">
Le titre de l'article est utilisé en tant que balise <code class="tyto">&lt;h1&gt;</code> dans la
balise <code class="tyto">&lt;article&gt;</code> de la page HTML. Il est également utilisé en tant que
<code class="tyto">title=&quot;&quot;</code> dans l'onglet de la barre de menu (si le fichier est nommé
<q class="tyto">index.tyto</q>, et son dossier source ajouté dans le fichier du module
"navbar.raw").
</p>
<h4 role="heading" aria-level="4" id="toc_4" class="tyto">La date de l'article</h4>
<p class="tyto">
La date doit être valide et respecter le format <code class="tyto">AAAA-MM-JJ</code> ; exemple :
<code class="tyto">2024-02-29</code>. Dans les pages HTML du site, si ce dernier est configuré
en langue "fr", les dates sont modifiées pour respecter le format
d'affichage "JJ/MM/AAAA" dans la page HTML.
</p>
<h4 role="heading" aria-level="4" id="toc_5" class="tyto">Les étiquettes de l'article</h4>
<p class="tyto">
Elles sont séparées par une virgule. Il est inutile d'ajouter un espace
après. Dans la page HTML de l'article, la balise HTML
<code class="tyto">&lt;meta name=&quot;keywords&quot;</code>, contient aussi les étiquettes fournies dans la
configuration du domaine (section [DOMAIN], clé "tags"). Il est donc inutile
de les réécrire.
</p>
</time>
</article>
<!--# include virtual="/template/sidebar.html"-->
</main>
<!--# include virtual="/template/footer.html"-->
</div> <!-- #site_container -->
</body>
</html>