tyto-litterateur/README.md

131 lines
2.9 KiB
Markdown

# 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 an article
- go to domain directory ".../articles/"
- create an article file [myfile].tyto (see `tyto help article`)
- type `tyto wip myfile.tyto`
- [myfile].html is created in wip/ domain server directory
## 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
file: PyF
@code1.py
Lien vers 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)
{{
# É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 entré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
((
Télécharger le fichier ::PyF.
Ceci est un icode : {` <h1>Titre principale de l'article</h1> `}
))
```