tyto-litterateur/README.md

# This software needs tests !
This program can be tested and should mainly work. Please report any problems

Tyto - Littérateur is translated in french and english.
Official website not yet udpated for this new version.

# Commands
```
# Get commands help
tyto

# Get all documentation
tyto help all

# How to write words tags (strong...) and anchors
tyto help words anchor
```

# Create new domain
- create a domain directory, like www.domain.tld
- Go to this directory
- type `tyto new domain`
- type `tyto check domain` and PLEASE, CHECK configuration file
- create in new directory domain ".../articles/", an articl file [myfile].tyto (see help)
- type `wip myfile.tyto`


## Exemple d'article .tyto commenté
```
title:   Tests
about:   Tests divers
date:    2023-02-28
tags:    tests
authors: echolib

abbr:    CSS
         Cascading SteelSheet
         en

link:    le site est prêt
         https://forge.a-lec.org
         La forge libre

code:    MyPY
         @code1.py
         Test d'ajout de code depuis un fichier

-----
! TOC

#1 Titre 1
((
   Un peu de ::CSS et ::le site est prêt
   (( note
      Cet article est un test
   ))
))

#2 Citation
("
   cite: Auteur
   date: AAAA-MM-JJ
   book: Nom du livre
   lang: fr
   link: https://...
   
   ((
      Citation complète dans un paragraphe
   ))
)"

#2 Code (bloc)
{{ wrds_tags
   # Écrire les marqueurs de mots
   # Chaque marqueur à la classe CSS de la configuration
   # Astuce : ** + ← + `` + ← + très gras
   
   *`très gras`* => <strong>
   +`gras`+      => <b>
   /`italique`/  => <em>
   ;`italique`;  => <i>
   _`souligné`_  => <u>
   ~`effacé`~    => <del>
   [`cité`]      => <q>    # Contenu
   :`cité`:      => <cite> # auteur, nom
   |`perso`|     => <span>
   
   # Code dans un texte
   # ! Les marqueurs d'ouverture et de fermeture de code sont sur la MEME LIGNE
   
   {` <li>Une entée de liste</li> `} => <code>
   
   # ! Dans certains cas, il faut ajouter un espace après le 1er marqueur
   # et/ou avant le second. Ils seront automatiquement supprimés
   
   *`DOMAIN/articles/ `* # évite /` : marqueur italique ouvert
}}

#2 Une liste
# Liste. Classe CSS possible (défaut : celle dans la configuration)
# Une entrée de liste peut être ordonnée avec le signe "+" ou non avec "="
# Une liste peut contenir des entrées mixées ("+" et "=")
# mais au changement de signe, ajouter un signe !
# Possible d'écrire une entrée sur plusieurs lignes

(=
   =   Première entrée non ordonnée (ul)
   ==  Sous entrée non ordonnée
   +++ Première sous-sous entrée ordonnée (ol)
   +++ Seconde sous-sous entrée ordonnée
   =   Seconde entrée non ordonnée
   =   Troisième entrée ...
       ... non ordonnée
)=

::MyPY
```

## Output HTML
```
<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="2023-12-31 12:10:19">
<header id="article_header">
<h1 id="article_title">
<a id="article_title_link" href="https://tyto.echolib.re/test.html" title="Tests -- echolib, 28/02/2023">Tests</a>
</h1>
<div id="article_refs">
echolib, 28/02/2023 [<a id="post_code" class="tyto" href="./test.tyto" title="Code source : Tests">Code source</a>]
</div>
</header>
<h2 class="toc_title">Table des matières</h2>
<nav class="toc" aria-labelledby="navigation-0">
<ul class="toc_items">
<li class="toc_item"><a class="toc_item_link tyto" href="#toc_1">Titre 1</a></li>
<ul>
<li class="toc_item"><a class="toc_item_link tyto" href="#toc_2">Citation</a></li>
<li class="toc_item"><a class="toc_item_link tyto" href="#toc_3">Code (bloc)</a></li>
<li class="toc_item"><a class="toc_item_link tyto" href="#toc_4">Une liste</a></li>
</ul>
</ul>
</nav>
<h2 id="toc_1" class="tyto">Titre 1</h2>
<p class="tyto">
Un peu de <abbr class="tyto" title="Cascading SteelSheet" lang="en">CSS</abbr> et <a class="tyto" href="https://forge.a-lec.org" title="La forge libre">le site est prêt</a>
<p class="note">
Cet article est un test
</p>
</p>
<h3 id="toc_2" class="tyto">Citation</h3>
<blockquote class="tyto" cite="https://..." lang="fr" title="-- Auteur, Nom du livre, AAAA-MM-JJ"><time datetime="AAAA-MM-JJ">
<p class="tyto">
Citation complète dans un paragraphe
</p>
</time><footer class="tyto"><a class="tyto" href="https://...">-- Auteur, Nom du livre, AAAA-MM-JJ</a></footer></blockquote>
<h3 id="toc_3" class="tyto">Code (bloc)</h3>
<pre class="wrds_tags_pre">
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">1</span><span class="wrds_tags_span wrds_tags_line"># Écrire les marqueurs de mots</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">2</span><span class="wrds_tags_span wrds_tags_line"># Chaque marqueur à la classe CSS de la configuration</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">3</span><span class="wrds_tags_span wrds_tags_line"># Astuce : ** + ← + `` + ← + très gras</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">4</span><span class="wrds_tags_span wrds_tags_line"></span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">5</span><span class="wrds_tags_span wrds_tags_line">*`très gras`* =&gt; &lt;strong&gt;</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">6</span><span class="wrds_tags_span wrds_tags_line">+`gras`+      =&gt; &lt;b&gt;</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">7</span><span class="wrds_tags_span wrds_tags_line">/`italique`/  =&gt; &lt;em&gt;</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">8</span><span class="wrds_tags_span wrds_tags_line">;`italique`;  =&gt; &lt;i&gt;</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">9</span><span class="wrds_tags_span wrds_tags_line">_`souligné`_  =&gt; &lt;u&gt;</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">10</span><span class="wrds_tags_span wrds_tags_line">~`effacé`~    =&gt; &lt;del&gt;</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">11</span><span class="wrds_tags_span wrds_tags_line">[`cité`]      =&gt; &lt;q&gt;    # Contenu</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">12</span><span class="wrds_tags_span wrds_tags_line">:`cité`:      =&gt; &lt;cite&gt; # auteur, nom</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">13</span><span class="wrds_tags_span wrds_tags_line">|`perso`|     =&gt; &lt;span&gt;</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">14</span><span class="wrds_tags_span wrds_tags_line"></span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">15</span><span class="wrds_tags_span wrds_tags_line"># Code dans un texte</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">16</span><span class="wrds_tags_span wrds_tags_line"># ! Les marqueurs d&apos;ouverture et de fermeture de code sont sur la MEME LIGNE</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">17</span><span class="wrds_tags_span wrds_tags_line"></span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">18</span><span class="wrds_tags_span wrds_tags_line">{` &lt;li&gt;Une entée de liste&lt;/li&gt; `} =&gt; &lt;code&gt;</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">19</span><span class="wrds_tags_span wrds_tags_line"></span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">20</span><span class="wrds_tags_span wrds_tags_line"># ! Dans certains cas, il faut ajouter un espace après le 1er marqueur</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">21</span><span class="wrds_tags_span wrds_tags_line"># et/ou avant le second. Ils seront automatiquement supprimés</span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">22</span><span class="wrds_tags_span wrds_tags_line"></span></code>
<code class="wrds_tags"><span class="wrds_tags_span wrds_tags_ln">23</span><span class="wrds_tags_span wrds_tags_line">*`DOMAIN/articles/ `* # évite /` : marqueur italique ouvert</span></code>
</pre>
<h3 id="toc_4" class="tyto">Une liste</h3>
<ul class="tyto">
<li class="tyto">Première entrée non ordonnée (ul)</li>
<ul>
<li class="tyto">Sous entrée non ordonnée</li>
<ol>
<li class="tyto">Première sous-sous entrée ordonnée (ol)</li>
<li class="tyto">Seconde sous-sous entrée ordonnée</li>
</ol>
</ul>
<li class="tyto">Seconde entrée non ordonnée</li>
<li class="tyto">Troisième entrée ... ... non ordonnée</li>
</ul>
<!-- Test d'ajout de code depuis un fichier -->
<pre class="bcode_pre">
<code class="bcode"><span class="bcode_span bcode_ln">1</span><span class="bcode_span bcode_line">#</span></code>
<code class="bcode"><span class="bcode_span bcode_ln">2</span><span class="bcode_span bcode_line"># Code 1</span></code>
<code class="bcode"><span class="bcode_span bcode_ln">3</span><span class="bcode_span bcode_line">#</span></code>
<code class="bcode"><span class="bcode_span bcode_ln">4</span><span class="bcode_span bcode_line"></span></code>
</pre>
</time>
</article>

<!--# include virtual="/template/sidebar.html"-->

</main>

<!--# include virtual="/template/footer.html"-->

</div> <!-- #site_container -->

</body>
```