title:   Écrire un article au format .tyto
about:   Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur
date:    2024-01-06
tags:    format .tyto,écrire,
authors: echolib
logo:    @logos/format_tyto.png

link:    Les métadonnées indispensables
         ./metas_obligatoires.html
         Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur

link:    Écrire/créer des liens
         ./metas_liens.html
         Comment écrire des liens pour Tyto - Littérateur

link:    Les URIs spécifiques
         ./metas_uris.html
         Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur

link:    Écrire les titres
         ./redac_titres.html
         Comment écrire les titres et les sous-titres pour Tyto - Littérateur

! LOGO
-------------------------------------------------------------------------------
! TOC

#1 Le format ".tyto" ?
((
   Pour que :`Tyto`: 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 :
   (=
      = avoir l'extension [...]*` .tyto `*
      = contenir un séparateur d'au moins 5 tirets {` ----- `}
   )=
))


#2 Le séparateur ?
((
   Le séparateur permet de créer 2 parties dans l'article source, *`Au dessus du
   séparateur : l'entête`*. Elle contient les métadonnées, comme le titre de
   l'article, sa date de création, et encore, les liens et images à configurer.
   *`Sous le séparateur : la rédaction`*. Elle contient les textes et les
   marqueurs dédiés au formattge des textes.
))


#2 Dans l'entête
((
   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 :
   (=
      = Les métadonnées indispensables
      = les métadonnées optionnelles
   )=
))

#3 Les métadonnées indispensables
((
   ::Les métadonnées indispensables ont des marqueurs uniques qui doivent être
   configurés sur une seule ligne.
))

#3 Les métadonnées optionnelles
((
   Les métadonnées optionnels peuvent avoir des marqueurs multiples qui doivent
   être configurés sur 3 lignes, hormis pour >`toc_6:les marqueurs de gestion`<
))
((
   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 {` :: `}.
   (=
      = ::Écrire/créer des liens
      = ::Les URIs spécifiques
   )=
))

#3 Les marqueurs de gestion
((
   Les marqueurs de gestion sont uniques, ptionnels et sans métadonnée.
   (=
      = +`! NOMAP`+ : article non présent dans le sitemap
      = +`! NORSS`+ : article non présent dans le flux RSS
      = +`! LOGO`+  : Montre le logo de l'article près de son titre 
   )=
))


#2 Dans la rédaction
((
   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.
   (=
      = ::Écrire les titres, créer la table des matières
   )=
))


#1 Rappel
((
   La commande {` tyto help `} regroupe différentes sections d'aides. Vous 
   pouvez par exemple taper {` tyto help article `} pour avoir un aperçu de
   tous les marqueurs, ou simplement taper {` tyto help anchor`} pour savoir
   comment définir une ancre et le lien pointant vers elle.
))