help usage translated in French. TODO: same in english

This commit is contained in:
Cyrille L 2023-04-05 12:37:37 +02:00
parent b85b66b429
commit 7051212826
2 changed files with 96 additions and 60 deletions

View File

@ -238,14 +238,15 @@ footer_about_doc = \
args_helps = """\n# New domain:
- Create your domain folder, and go in
- Create domain with 'tyto new domain [URL]'
- Create article\'s file in articles/ directory
- Use these actions on article\'s file: Check > wip > publish
! Config\'s files are in _configs/ directory
- Create article file in articles/ directory
- Use these actions on article file: Check > wip > publish
! Config files are in _configs/ directory
and used to create HTML file in your template
Your template files (css, logo...) go to wip/template/ server\n
Your template files (css, logo...) go to wip/template/ server
# Usage: tyto [action] [target]
- [action] > according to [target]:
edit : Edit a file (article, config's module)
edit : Edit a file (article, config module)
edit-about: specific for (footer), or like [edit-db]
edit-db : Edit a config file (domain, article (TAKE CARE !))
edit-wip : Edit html file in wip server
@ -253,7 +254,7 @@ args_helps = """\n# New domain:
new : Create new (domain, sidebar/footer... config's file)
show : Show content file (article, config's module)
show-about: specific for (footer), or like [show-db]
show-db : Show content of article\'s database
show-db : Show content of article database
show-wip : Show content of HTML file in wip server
show-www : Show content of HTML file in www server\n
check : Check if article is valid and ready to convert
@ -267,14 +268,14 @@ args_helps = """\n# New domain:
template : - Create new navbar/sidebar/metas/footer in www server
- Copy other wip/template/ files to www server
domain : Create/Show domain config's file
[file] : URI of an article's file (autocompletion's friend)
footer : Create/Show footer HTML config's file
metas : Create/Show metas HTML config's file
navbar : Create/Show navbar config's file
sidebar : Create/Show sidebar config's file
[file] : URI of an article file (autocompletion's friend)
footer : Create/Show footer HTML config file
metas : Create/Show metas HTML config file
navbar : Create/Show navbar config file
sidebar : Create/Show sidebar config file
stats : Create statistics file in root server\n
# Examples:
- Check article's syntax: tyto check mysubdir/index.tyto
- Check article syntax: tyto check mysubdir/index.tyto
- Create default _configs/tyto.sidebar: tyto new sidebar
- Edit _configs/tyto.navbar: tyto edit navbar
(each edition launches process if file changed like:

View File

@ -235,52 +235,87 @@ footer_about_doc = \
'# %s\n'%(20 * "-")
# Help with Tyto commands
args_helps = """\n# New domain:
- Create your domain folder, and go in
- Create domain with 'tyto new domain [URL]'
- Create article\'s file in articles/ directory
- Use these actions on article\'s file: Check > wip > publish
! Config\'s files are in _configs/ directory
and used to create HTML file in your template
Your template files (css, logo...) go to wip/template/ server\n
args_helps = """\n# Nouveau domaine :
- Créer un dossier et aller dedans
- Créer un domain avec 'tyto new domain [URL]'
- Créer un fichier .tyto dans le dossier articles/
- Utiliser les actions check > wip > publish
! - Les fichiers des modules sont dans le dossier _configs/
et utilisés pour personnaliser certaines parties du site
- Les fichier (css, logo...) vont dans le dossier serveur wip/template/
# Usage: tyto [action] [target]
- [action] > according to [target]:
edit : Edit a file (article, config's module)
edit-about: specific for (footer), or like [edit-db]
edit-db : Edit a config file (domain, article (TAKE CARE !))
edit-wip : Edit html file in wip server
edit_www : Edit html file in www server
new : Create new (domain, sidebar/footer... config's file)
show : Show content file (article, config's module)
show-about: specific for (footer), or like [show-db]
show-db : Show content of article\'s database
show-wip : Show content of HTML file in wip server
show-www : Show content of HTML file in www server\n
check : Check if article is valid and ready to convert
wip : Create HTML page in wip server
publish : Create HTML page in www server\n
- [target] > according to [action]
all : process (updated) valid articles
again : process again ALL valid articles
newer : [wip/publish] convert only newer articles
template : - Create new navbar/sidebar/metas/footer in www server
- Copy other wip/template/ files to www server
domain : Create/Show domain config's file
[file] : URI of an article's file (autocompletion's friend)
footer : Create/Show footer HTML config's file
metas : Create/Show metas HTML config's file
navbar : Create/Show navbar config's file
sidebar : Create/Show sidebar config's file
stats : Create statistics file in root server\n
# Examples:
- Check article's syntax: tyto check mysubdir/index.tyto
- Create default _configs/tyto.sidebar: tyto new sidebar
- Edit _configs/tyto.navbar: tyto edit navbar
(each edition launches process if file changed like:
- check
- (navbar, sidebar, metas, footer) : create file on wip server)
- Edit index.html in www server: tyto edit-www index.tyto
- Create sidebar.html in wip server: tyto wip sidebar
- Show footer.html in wip server: tyto show-wip footer
- Create metas.html in www server: tyto publish metas
- Show navbar.html in www server: tyto show-www navbar"""
# Les actions
- [action] > Selon l'argument [target]
# Modifier un ficher
edit : fichier source, module de configuration
edit-about: [footer] Modifier la section description du pied de page
sinon comme l'action [edit-db]
edit-db : Modifier une base de données/fichier de configuration
edit-wip : Modifier un fichier dans le serveur 'wip'
edit_www : Modifier un fichier dans le serveur 'www'
new : [domain] Créer un domaine ou le modifier via le formulaire
[sidebar, navbar, footer, metas] Créer ou remplacer le
fichier de configuration du module par le défaut
# Afficher un fichier (avec numéros de ligne)
show : fichier source, module de configuration
show-about: [footer] Afficher la section description du pied de page
sinon comme l'action [show-db]
show-db : Afficher une base de données/fichier de configuration
show-wip : Afficher un fichier dans le serveur 'wip'
show-www : Afficher un fichier dans le serveur 'www'
# Processus de création / Mise en ligne
check : Vérifier la validité d'un article au format tyto
wip : Créer une page HTML de l'article dans le serveur 'wip'
publish : Créer une page HTML de l'article dans le serveur 'www'
# Les cibles
- [target] > Selon l'action [action]
# Traitement en masse
all : Mise à jour des articles modifiés (déjà vérifiés)
again : Forcer TOUS les articles déjà vérifiés
newer : [check] Vérifier tous les article .tyto dans le domaine
qui n'ont pas été déjà vérifiés
[wip, publish] Créer les pages HTML des articles
qui ont été modifiés et vérifiés
# Mise en ligne du thème et des modules
template : - Recréer les modules dans le serveur 'www'
- Copie tous les autres fichier du dossier wip/template/
# Domaine et fichier
domain : Créer un domain ou le modifier
[file] : URI du fichier (l'autocompletion est votre amie)
# Les modules
footer : Fichier de configuration du pied de page
metas : Fichier de configuration des balises HTML <meta>, <link>
navbar : Fichier de configuration du menu de navigation
sidebar : Fichier de configuration de la barre latérale
stats : Fichier de statistiques (serveur 'wip' ou 'www')
# Exemples :
# Vérifier l'article dans le sous dossier (suivant l'emplacement)
$ tyto check mysubdir/index.tyto
# Créer ou remettre par défaut la barre latérale
$ tyto new sidebar
# Modifier la configuration du menu de navigation
$ tyto edit navbar
# Modifier doc/index.html dans le serveur 'www'
$ tyto edit-www doc/index.tyto
# Créer le module HTML (serveur 'wip') de la barre latérale
$ tyto wip sidebar
# Afficher le contenu du pied de page HTML dans le serveur 'wip'
$ tyto show-wip footer
# Créer le fichier de statistiques dans le serveur 'www'
$ tyto publish stats"""