tyto-litterateur/website_doc/article/index.html

163 lines
8.4 KiB
HTML

<!-- Écrire un article au format .tyto - 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 un article au format .tyto">
<meta name="author" content="echolib">
<meta name="description" content="Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur">
<meta name="keywords" content="Tyto,littérateur,logiciel libre,documentation,format .tyto,écrire,">
<!-- metas links to template files -->
<link rel="canonical" href="https://tyto.echolib.re/article/index.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 un article au format .tyto">
<meta property="og:type" content="article">
<meta property="og:url" content="https://tyto.echolib.re/article/index.html">
<meta property="og:description" content="Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur">
<meta property="og:image" content="https://tyto.echolib.re/images/logos/format_tyto.png">
<!-- Publication date and title -->
<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date">
<title>Écrire un article au format .tyto (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/format_tyto.png" alt="Écrire un article au format .tyto">
<h1 role="heading" aria-level="1" id="article_title">
<a role="link" id="article_title_link" href="https://tyto.echolib.re/article/index.html" title="Écrire un article au format .tyto -- echolib, 06/01/2024">Écrire un article au format .tyto</a>
</h1>
<div id="article_refs">
echolib, 06/01/2024 [<a id="post_code" class="tyto" href="./index.tyto" title="Code source : Écrire un article au format .tyto">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">Le format ".tyto" ?</a></li>
<ul>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_2">Le séparateur ?</a></li>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_3">Dans l'entête</a></li>
<ul>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_4">Les métadonnées indispensables</a></li>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_5">Les métadonnées optionnelles</a></li>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_6">Les marqueurs de gestion</a></li>
</ul>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_7">Dans la rédaction</a></li>
</ul>
<li role="listitem" class="toc_item"><a class="toc_item_link tyto" href="#toc_8">Rappel</a></li>
</ul>
</nav>
<h2 role="heading" aria-level="2" id="toc_1" class="tyto">Le format ".tyto" ?</h2>
<p class="tyto">
Pour que <cite class="tyto">Tyto</cite> puisse convertir un contenu rédactionnel dans un fichier
textuel brut en page HTML5, il faut utiliser des marqueurs, et respecter une
structure dans le fichier source. Il est recommandé d'utiliser un simple
éditeur de texte. Ce fichier doit :
<ul role="list" class="tyto">
<li role="listitem" class="tyto">avoir l'extension [...]<strong class="tyto">.tyto</strong></li>
<li role="listitem" class="tyto">contenir un séparateur d'au moins 5 tirets <code class="tyto">-----</code></li>
</ul>
</p>
<h3 role="heading" aria-level="3" id="toc_2" class="tyto">Le séparateur ?</h3>
<p class="tyto">
Le séparateur permet de créer 2 parties dans l'article source, <strong class="tyto">Au dessus du
séparateur : l'entête</strong>. Elle contient les métadonnées, comme le titre de
l'article, sa date de création, et encore, les liens et images à configurer.
<strong class="tyto">Sous le séparateur : la rédaction</strong>. Elle contient les textes et les
marqueurs dédiés au formattge des textes.
</p>
<h3 role="heading" aria-level="3" id="toc_3" class="tyto">Dans l'entête</h3>
<p class="tyto">
Une métadonnée est composée par un marqueur, et ses contenus. Il y a 2 types
de métadonnées dans l'entête :
<ul role="list" class="tyto">
<li role="listitem" class="tyto">Les métadonnées indispensables</li>
<li role="listitem" class="tyto">les métadonnées optionnelles</li>
</ul>
</p>
<h4 role="heading" aria-level="4" id="toc_4" class="tyto">Les métadonnées indispensables</h4>
<p class="tyto">
<a role="link" class="tyto" href="./metas_obligatoires.html" title="Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur">Les métadonnées indispensables</a> ont des marqueurs uniques qui doivent être
configurés sur une seule ligne.
</p>
<h4 role="heading" aria-level="4" id="toc_5" class="tyto">Les métadonnées optionnelles</h4>
<p class="tyto">
Les métadonnées optionnels peuvent avoir des marqueurs multiples qui doivent
être configurés sur 3 lignes, hormis pour <a class="tyto" href="#toc_6">les marqueurs de gestion</a>
</p>
<p class="tyto">
La 1ère ligne comprend le marqueur, suvi par son identité. Cette identité
doit être unique (toutes identités confondues), et doit être reprise dans
les contenus rédactionnels, préfixée par <code class="tyto">::</code>.
<ul role="list" class="tyto">
<li role="listitem" class="tyto"><a role="link" class="tyto" href="./metas_liens.html" title="Comment écrire des liens pour Tyto - Littérateur">Écrire/créer des liens</a></li>
<li role="listitem" class="tyto"><a role="link" class="tyto" href="./metas_uris.html" title="Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur">Les URIs spécifiques</a></li>
</ul>
</p>
<h4 role="heading" aria-level="4" id="toc_6" class="tyto">Les marqueurs de gestion</h4>
<p class="tyto">
Les marqueurs de gestion sont uniques, ptionnels et sans métadonnée.
<ul role="list" class="tyto">
<li role="listitem" class="tyto"><b class="tyto">! NOMAP</b> : article non présent dans le sitemap</li>
<li role="listitem" class="tyto"><b class="tyto">! NORSS</b> : article non présent dans le flux RSS</li>
<li role="listitem" class="tyto"><b class="tyto">! LOGO</b> : Montre le logo de l'article près de son titre </li>
</ul>
</p>
<h3 role="heading" aria-level="3" id="toc_7" class="tyto">Dans la rédaction</h3>
<p class="tyto">
Dans la zone des contenus rédactionnels - sous le séparateur, les retours
à la lignes n'ont aucun effet sur la page HTML, afin de rendre les documents
plus lisibles et aérés. Il est également utile d'indenter les marqueurs
de blocs et leurs contenus.
<ul role="list" class="tyto">
<li role="listitem" class="tyto"><a role="link" class="tyto" href="./redac_titres.html" title="Comment écrire les titres et les sous-titres pour Tyto - Littérateur">Écrire les titres</a>, créer la table des matières</li>
</ul>
</p>
<h2 role="heading" aria-level="2" id="toc_8" class="tyto">Rappel</h2>
<p class="tyto">
La commande <code class="tyto">tyto help</code> regroupe différentes sections d'aides. Vous
pouvez par exemple taper <code class="tyto">tyto help article</code> pour avoir un aperçu de
tous les marqueurs, ou simplement taper <code class="tyto">tyto help anchor</code> pour savoir
comment définir une ancre et le lien pointant vers elle.
</p>
</time>
</article>
<!--# include virtual="/template/sidebar.html"-->
</main>
<!--# include virtual="/template/footer.html"-->
</div> <!-- #site_container -->
</body>
</html>