tyto-litterateur/README.md

219 lines
5.9 KiB
Markdown
Raw Normal View History

2023-09-22 11:52:44 +02:00
# Very early IN dev code
This program can ve tested but not at all usable. Lots of work to do...
2022-11-16 11:45:39 +01:00
2023-09-22 11:52:44 +02:00
# Commands
2022-11-26 12:34:59 +01:00
```
2023-09-22 11:52:44 +02:00
# Get commands list help
tyto
2022-11-26 12:34:59 +01:00
```
2023-09-25 14:55:51 +02:00
## ToDo next (working on)
- added lists to post database (prepared wip)
## Working on
- 'wip' action processes
- - images module
## ToDo
- thinking about creating an auto top article menu from titles
- create full HTML page
- sitemaps
- RSS
- 'publish' process
2023-03-07 17:49:50 +01:00
## Exemple d'article .tyto commenté
2023-10-26 18:59:56 +02:00
```
2023-10-27 17:40:10 +02:00
#================================================#
# Entete de l'article #
# Fin de l'entête avec au moins 5 tirets "-----" #
# Toute ligne de commentaire "# ..." est ignorée #
# ! Recommandé de ne pas utiliser le signe "_" #
2023-10-27 17:40:10 +02:00
#================================================#
# Pour ne pas inclure cet article dans les sitemaps :
2023-10-26 18:59:56 +02:00
! NoSitemap
2023-10-27 17:40:10 +02:00
# Données uniques sur UNE ligne
2023-10-26 18:59:56 +02:00
title: tests d'un article
about: À propos de cet article de test
2023-10-27 17:40:10 +02:00
tags: Tyto, tuto,
2023-10-26 18:59:56 +02:00
author: echolib
2023-10-27 17:40:10 +02:00
date: 2023-10-27
2023-10-26 18:59:56 +02:00
# Données unique sur UNE ligne optionnelle
# Si non définit, le logo du domaine est utilisé
# Ne sera affiché qu'avec _image:logo
logo: post-logo.png
# Données multiples sur 3 lignes
# [TAG]: Nom
# LIEN
# Text alternatif
2023-10-27 17:40:10 +02:00
link: cliquer sur ce Lien
2023-10-26 18:59:56 +02:00
https://
Text alternatif
link: Réservez ici
https://
Billets
file: télécharger ce fichier
2023-10-27 17:40:10 +02:00
@/PDFs/hello.pdf
2023-10-26 18:59:56 +02:00
Un PDF !
code: codetest
@RAWS/test.py
Exemple d'un code Python
# Les abréviations :
# 2eme ligne: Texte alternatif
# 3ème ligne: valeur affichée dans l'article à la place du Nom
abbr: HTML
HuperText Markup Langage
HTML
abbr: css
Cascading Stylesheet
CSS
2023-10-27 17:40:10 +02:00
-----
2023-10-26 18:59:56 +02:00
2023-10-27 17:40:10 +02:00
#=====================================================================#
# Contenu de l'article #
# Les classe optionnelles non renseignées deviennent celle du domaine #
# /!\ Tout code HTML sera interprêté par le navigateur sauf si placé #
# entre les marqueurs de block-code ou icode #
2023-10-27 17:40:10 +02:00
#=====================================================================#
2023-10-26 18:59:56 +02:00
# La ligne suivante est un commentaire HTML "<!-- Commentaire -->"
# ----------------------------------------------------------------
2023-10-26 18:59:56 +02:00
;; Commentaire
2023-10-27 17:40:10 +02:00
# Ceci est une ancre avec l'ID uniq1 (ID unique)
# ----------------------------------------------
2023-10-27 17:40:10 +02:00
-> uniq1
2023-10-26 18:59:56 +02:00
-> top
2023-10-27 17:40:10 +02:00
# Créer un lien vers l'ancre "uniq1"
# ----------------------------------
2023-10-27 17:40:10 +02:00
>_uniq1: Go to uniq1 anchor_<
# Ceci est une ligne <hr> ayant pour classe hrcss
# -----------------------------------------------
2023-10-27 17:40:10 +02:00
-- hrcss
# Les Titres de l'article de #1 à #5 (<h2> à <h6>)
# ------------------------------------------------
2023-10-26 18:59:56 +02:00
#1 Titre en h2
# Contenu dans un paragraphe entre (( ... )) ayant pour classe "mypar"
# --------------------------------------------------------------------
2023-10-27 17:40:10 +02:00
(( mypar
Un long paragraphe...
# Retour à la ligne avec un <br /> de classe brcss
# (les retours à la ligne vides ne sont pas pris en compte)
# ---------------------------------------------------------
2023-10-27 17:40:10 +02:00
| brcss
# Reprise du Nom pour les liens de link: et file:
# Reprise des abréviations
2023-10-27 17:40:10 +02:00
Il faut __cliquer sur ce Lien, __Réservez ici et --télécharger ce fichier
ou encore faire une ::css pour du beau rendu ::HTML
2023-10-27 17:40:10 +02:00
# Un paragraphe dans le paragraphe ayant pour classe, celle du domaine
# --------------------------------------------------------------------
2023-10-26 18:59:56 +02:00
((
2023-10-27 17:40:10 +02:00
Un /_court_/ paragraphe de :_1984_: pour de ~_vrai_~ +_faux en gras_+
Il faut le ._souligner_. et *_Très Gras_*
2023-10-26 18:59:56 +02:00
))
# Créer un icode (utilise la balise <code> HTML)
# /!\ ! Doit être sur une même ligne
# ----------------------------------------------
2023-10-27 17:40:10 +02:00
{_<ol>, <ul>_}
{_{_Afficher un icode brut_}_}
2023-10-26 18:59:56 +02:00
))
# Un exemple de block code ayant pour classe python
2023-10-27 17:40:10 +02:00
# Tout contenu entre les marqueurs "{{" et "}}" est conservé
# ----------------------------------------------------------
#2 Block Code
2023-10-27 17:40:10 +02:00
{{ python
# Un commentaire et du code
def hello(world):
world and print(world) or print("NoMore")
2023-10-26 18:59:56 +02:00
}}
# Écrire en gras, italique...
# ---------------------------
#2 Marqueurs de mots
((
Même si, il est possible d'écrire directement des balises (HTML), Tyto
propose de les simplifier, en entourant les mots avec des marqueurs. La
classe CSS du domaine est utilisée pour chaque marqueur.
{{
*_Très Gras_* > <strong>
+_En Gras_+ > <b>
[_Citer un texte_] > <q>
:_Citer une référence_: > <cite>
~_Texte barré_~ > <del>
._Text souligné_. > <u>
/_En italique_/ > <em>
;_En italique_; > <i>
# Marques multiples, ajouter "&"
*_&._Très gras et souligné_.&_*
}}
))
2023-10-27 17:40:10 +02:00
# Dans un block div [[ ... ]] (classe CSS mydiv),
# La citation entre [" ... "] (classe CSS mycite)
# est placée dans un paragraphe (classe CSS mycite)
# ! Tout commentaire "# ..." dans la citation sera affiché...
# -----------------------------------------------------------
#2 Citation
2023-10-27 17:40:10 +02:00
[[ mydiv
[" mycite
2023-10-26 18:59:56 +02:00
;; A great quote here !
cite: Someone
date: 2023-10-13
book: A History
2023-10-27 17:40:10 +02:00
lang: en
2023-10-26 18:59:56 +02:00
link: https://...
2023-10-27 17:40:10 +02:00
(( mycite
2023-10-26 18:59:56 +02:00
Here, i am
))
"]
]]
2023-10-27 17:40:10 +02:00
# Créer une liste ol/ul entre <: ... :> (classe mylist)
# dans un paragraphe (classe du domaine)
# "+" pour ol, "=" pour ul
# Ajouter toujours un signe pour un sous-item ou /!\ au changement de signe
# -------------------------------------------------------------------------
2023-10-27 17:40:10 +02:00
#2 Une liste mixée {_<ol>, <ul>_}
((
<: mylist
+ numeric o: item 1
++ numeric ol sub-Item 1
+++ numeric ol sub-sub-item 1
==== ul item >_top: Go to Top_<
==== ul item >_top: Another anchor_<
:>
))
# Afficher un block code avec le contenu d'un fichier
# Il doit avoir été configuré dans l'entête
# -----------------------------------------
#2 Un block code depuis un fichier
_code:codetest
2023-10-26 18:59:56 +02:00
```