tyto-litterateur/README.md

244 lines
4.3 KiB
Markdown

# Tyto
Pour obtenir de l'aide, taper juste la commande tyto
## Répertoire de code du projet Tyto
## Comment définir les métas
```
# Obligatoires uniques
title: Titre
about: Infos de l'article
author: Auteur
tags: mots-clé-1,mots-clé-2
date: YYYY-MM-DD (AAAA-MM-JJ)
# Optionnels multiples
link: Nom du lien
URL
Texte Alternatif
image: Nom
URI
Texte Alternatif
file: Nom du lien
URL
Texte Alternatif
raw : Nom
URI
Texte Alternatif
abbr: NOM (en majuscule)
Définition du NOM
nom (forme à afficher dans l'artile (optionnel))
# L'image doit d'abord être configurée
# Utiliser l'image précisée comme défaut dans les réseaux sociaux
snpic: Nom
# Séparateur d'au moins 5 "-" pour définir la fin
# des métadonnées d'entête de l'article
----------
```
## Comment écrire un article
### Écrire des titres
```
# Les titres HTML vont de 1 à 6.
# Utiliser #N, où N est entre 1 et 6.
# Si du contenu existe entre les titres, une <div> est ajoutée
# Astuce: on commence en général par #2 dans l'article
# Source
#1 Titre 1
Contenu 1
#2 Titre 2
#3 Titre 3
contenu 2
#4 Titre 4
# HTML
<h1 class="title_1">Titre 1</h1>
<div class="content_title">
Contenu 1
</div>
<h2 class="title_2">Titre 2</h2>
<h3 class="title_3">Titre 3</h3>
<div class="content_title">
contenu 2
</div>
<h4 class="title_4">Titre 4</h4>
```
### Paragraphes
```
(( CSS
Un paragraphe
))
```
### Code Brut
```
{{ CSS
def hello_world():
print("Hello")
}}
```
### Listes ul/ol
```
-( CSS
= Liste ul
== Sous-liste ul
=== Sous-sous-liste ul
++++ Sous-sous-sous-liste ol
+++ Sous-sous-liste ol
-)
```
### Citations
```
[[ CSS
_cite: autheur
_lang: langue
_link: lien
_year: année ou date YYYY-MM-DD
_book: référence
((
Citation placée dans un paragraphe
))
]]
[[ CSS
Citation simple sans référence
]]
```
### Ancres
```
-> id
((
un long paragraphe
))
((
>_id:Retourner au point d'ancre id_<
))
```
### Retour à la ligne HTML
```
| # <br />
```
### Lien vers URL
```
Voir ce _Nom du lien # Ouverture même fenêtre
Voir ce _Nom du lien+ # ouverture nouvelle fenêtre
```
### Lien vers fichier
```
Voir ce __Nom du lien # Ouverture même fenêtre
Voir ce __Nom du lien+ # ouverture nouvelle fenêtre
```
Note:
Vous pouvez avoir un NAME identique pour file: et link:
### Gras, Strong, italique...
```
*_très gras_* # <strong>
+_gras léger_+ # <b>
/_en italique_/ # <em>
[_en italique_] # <i>
~_texte barré_~ # <del>
:_Citation rapide_: # <cite>
%_Classe personnalisée_% >>> <span class="custom">
._Souligné_. # <u>
{_Code_} # <code>
# Montrer comment écrire du code dans Tyto:
# Bypass avec \ devant {_ et _}
{_\{_Comme ça\_}_}
```
### Abréviations
```
# NOM sera remplacé par "nom" dans la page si défini en entête
# sinon, NOM sera conservé
# - Toujours écrire en majuscule les ABBR dans l'article brut
# - Mettre '!' devant NOM dans l'article
Avec ce !NOM.
# HTML: <abbr title="Définition du NOM">nom</abbr>
```
### Images
```
# Chaque image doit être placée en début de ligne
# Placer dans un paragraphe pour chacune ou après "|",
# sinon, affichage les une à côté des autres
# ! Si pas d'unité pour w= et h= : défaut "px"
_image:Nom
_image:Nom c=CSS
_image:Nom c=css w=1080
_image:Nom w=640em h=480em
_image:Nom t=+ # Rend l'image interne cliquable
_image:Nom t=https://...# Donne un lien web à l'image
_image:Nom c=CSS t=https://... w=320px h=240 # 240px
```
### Code brut depuis un fichier
```
_raw:NOM
```
### Citations
Possibilité dans toute citation d'utiliser les marqueurs
optionnels _xxx. Pour la date, utilisez le FORMAT INTERNATIONAL
```
# Source
[[ CSS_TEST
_cite: echolib
_date: 2022-12-28
_lang: fr
_link: https://tyto.echolib.re
_book: Référence
((
Pfff, vraiment !
))
]]
# HTML
<figure class="CSS_TEST">
<blockquote class="CSS_TEST" lang="fr" cite="https://tyto.echolib.re" title="echolib - Reference (2022-12-28)">
<time datetime="2022-12-28">
<p class="tyto">
Pfff, vraiment !
</p>
</time>
</blockquote>
<figcaption class="CSS_TEST">
<a class="figc" href="https://tyto.echolib.re">echolib - Reference (2022-12-28)</a>
</figcaption>
</figure>
# Source
[[
Une citation simple, et sans paragraphe
]]
# HTML
<blockquote class="tyto">
Une citation simple, et sans paragraphe
</blockquote>
```