quickDoc
An e gonomic ligh weigh ma kup language wi h mnemonic inspi a ions o
w i ing all kind o documen s
Cyp ien PIERRE
2025-10-24
Résumé
Rédige le ésumé
Mo s-clés : Mo clé 1, Mo clé 2
1 In oduc ion
Le p ésen documen dé ini quickDoc, un nou eau langage de balisage lége conçu pou em-
place l’écosys ème ieillissan T
E
X/L
A
T
E
X/BibLaTeX e les o ma s ma kdown ac uels. quickDoc
ise à uni ie les a an ages de ces sys èmes ou en épondan à leu s limi a ions echniques, sé-
man iques e e gonomiques. Il es des iné à la édac ion de documen s scien i iques, li é ai es,
de documen a ion echnique e de publica ions, a ec des so ies PDF e HTML5 con o mes aux
no mes d’accessibili é WCAG ni eau AAA.
quickDoc pe me de s ocke e d’exp ime :
— du con enu ex uel o ma é (sec ions, emphase, ableaux, e c.),
— des données s uc u ées (mé adonnées, con igu a ions, ables de données ypées),
— du code exécu able in ég é (a ec a ichage du ésul a dans le documen ),
— des o mules ma héma iques (é aluables ou non pa un mo eu de calcul),
— des é é ences bibliog aphiques s anda d (in e opé an a ec CSL/BibTeX),
— des igu es, diag ammes, g aphiques e anno a ions a ec leu séman ique.
Ce documen es édigé sous la o me d’une spéci ica ion no ma i e de ype ISO/RFC. Il énonce
la e minologie, le modèle o mel (syn axe e g ammai e), les exigences onc ionnelles e non-
onc ionnelles, e les ègles d’accessibili é e d’in e opé abili é du langage quickDoc. Les mo s
”doi ” e ”ne doi pas” indiquen des exigences obliga oi es, andis que ”de ai ” indique une
ecommanda ion.
1
2 E a de l’a
Lap oduc iondedocumen s o ma éssui deuxapp oches dominan es.Lap emiè e eposesu
des ai emen s de ex e WYSIWYG comme MS Wo d, Google Docs ou OnlyO ice, qui exposen
g aphiquemen les opé a ions de mise en o me mais a eignen i e leu s limi es pou des
documen s exécu ables, c’es -à-di e des ex es où des élémen s son é alués puis emplacés
pa leu s ésul a s, commedu codegéné an un schéma ouundiag amme
a
[1,2,3].La seconde
app oche consis e à éc i e le con enu e son balisage dans un édi eu ex e (Neo im, Emacs, iA
W i e , e c.) puis à con ie le endu à un ou illage adap é, ce qui place un langage de balisage au
cœu du lux de édac ion, a ec des con e isseu s assu an la ans o ma ion e s HTML, PDF
ou EPUB [4,5]. Dans ce cad e, on dis ingue des langages o mels o ien és s uc u e e di usion
comme T
E
X ou HTML, e des langages de balisage lége (Ligh weigh Ma kup Language (LML))
els que Ma kdown, O g-mode, AsciiDoc ou eS uc u edTex , p é é és pou leu lisibili é en
clai e leu in ég a ion dans les p a iques «docs-as-code» [6,7,8,9].
T
E
X s’impose his o iquemen pou la composi ion de hau e quali é ia des mac os qui sous-
enden L
A
T
E
X, ConTeX , Texin o e OpTeX, a ec un écosys ème de packages cou an igu es,
bibliog aphies e disciplines spécialisées, mais au p ix d’une in as uc u e lou de, de choix
echniques nomb eux e de diagnos ics d’e eu s di iciles su de longs documen s [10,11,12].
Des assis an s comme LTeX+ e W i e ull amélio en la quali é édac ionnelle e la con o mi é,
sans ou e ois ésoud e les con ain es s uc u elles de la oolchain [13,14]. La ques ion de
l’accessibili édemeu e c i ique :lap oduc iondePDF balisése con o mes auxexigencesWCAG
es e ince aine sans pos - ai emen s spéci iques, en pa iculie pou les ma héma iques, ce
qui end nécessai e l’in ég a ion en amon de mé adonnées e s uc u es adap ées pou des
so ies éellemen u ilisables pa les echnologies d’assis ance [15,16,17,18].
Des sys èmes écen s che chen à mode nise l’expé ience de composi ion en combinan
syn axe compac e, p é isualisa ion apide, con ôle p og amma ique de la mise en o me
e messages d’e eu explici es, illus an une di ec ion de concep ion don quickDoc peu
s’inspi e pou ise une éac i i é p oche du emps éel ou en é i an les mul iples passes e
l’opaci é des chaînes T
E
X adi ionnelles [10,12]. D’au es app oches, comme Sc ibble dans
l’écosys ème Racke , mon en l’in é ê d’une documen a ion p og ammable où le documen
es un p og amme géné an du con enu, ce qui o e une ex ensibili é considé able mais es e
o emen couplé à l’en i onnemen hô e e peu accessible ho s de celui-ci ; l’objec i pou
quickDoc es de conse e l’ex ensibili é sans impose la lou deu d’un langage géné alis e aux
usages cou an s [16].
Cô é LML, Ma kdown demeu e le plus populai e g âce à une syn axe minimale e lisible, mais
son pé imè e limi é a p o oqué la p oli é a ion de dialec es hé é ogènes selon les pla e o mes,
malg é les e o s de no malisa ion de CommonMa k e la documen a ion de a ian es comme
GFMe le egis eIANA ;ce edi e si éimposeauxau eu sd’app end edes sous-ensemblesdis-
inc s e nui à la po abili é in e -ou ils [6,19,20,21]. O g-mode, ès in ég é à Emacs, appo e
une puissance séman ique e ou illée supé ieu e pou la plani ica ion, les ableaux, l’exécu ion
de code a ec ésul a s ep oduc ibles e l’expo mul i- o ma s, mais sa dépendance à Emacs
limi e sa po abili é e son adop ion ho s de ce en i onnemen [7]. AsciiDoc, aujou d’hui sous
a
.Documen exécu able : Désigne un documen don des élémen s son exécu és (p. ex. code) e emplacés
pa le p odui de l’exécu ion (p. ex. schéma ou diag ammes).
2 / 30
gou e nance Eclipse, p opose une cou e u e quasi exhaus i e des besoins de documen a ion
a ec admoni ions, inclusions, a iables e mac os, sou enue pa une spéci ica ion e un TCK
en cou s de o malisa ion, ce qui en ai un choix obus e pou la documen a ion logicielle e
les manuels, au p ix d’une cou be d’app en issage plus exigean e que Ma kdown [8,22,23,
24]. eS uc u edTex , conçu pou l’écosys ème Py hon e Sphinx, o e des di ec i es ex en-
sibles, des é é ences c oisées e des s uc u es de hau ni eau compa ables à AsciiDoc, mais
sa e bosi é e ses con en ions s ic es le ése en sou en à son oolchain d’o igine [9].
3 Limi es e oppo uni és
L’éme gence d’un besoin uni ié naî des limi es echniques, séman iques e e gonomiques
obse ées dans les sys èmes exis an s e des exigences nou elles liées aux lux «spec-d i en »
exploi és a ec des LLM, qui exigen des spéci ica ions s ables, es ables e ou illées dès le dépô
Gi [25,26,27,28]. Depuis la c éa ion de Ma kdown, les LML se son di usés dans les dépô s,
wikis, chaînes de documen a ion e blogs a ec la p omesse d’un ex e lisible e con e ible,
mais la p oli é a ion de a ian es incompa ibles e l’absence ini iale de no me obus e on
géné é des ambiguï és e des coû s de po abili é en e ou ils [6,19,20,21]. Les u ilisa eu s
poin en l’insu isance des onc ionnali és na i es pou les ableaux complexes, les é é ences
c oisées e l’inclusion de ichie s, qui o cen à mélange HTML e ex ensions, andis que des
al e na i es plus iches comme AsciiDoc, eS uc u edTex e O g-mode demeu en su ou
adop ées pa des communau és spécialisées [7,8,9,22].
Les c i iques écu en es s’a iculen au ou de la non-s anda disa ion de Ma kdown e de ses
dialec es, qui obligen à compose a ec plusieu s mo eu s de endu e alou dissen la cha ge
cogni i e, alo s que des e o s de no malisa ion e de es on mon é leu e icaci é quand
ils son accompagnés d’une spéci ica ion e d’un TCK publics [6,20,23,29]. Le manque de
onc ions in ég ées pou les no es, les é é ences, les inclusions e les ableaux condui à des
pipelines hé é ogènes, andis que des langages o ien és publica ion appo en admoni ions,
a iables, mac os e inclusions, au p ix d’une syn axe plus dense e d’ou ils dédiés (Asciidoc o ,
An o a, Sphinx, Emacs) [8,9,24,30]. La cou be d’app en issage es e pa adoxale : Ma kdown
es p i ilégié pou sa lisibili é su de pe i s documen s, mais AsciiDoc e eST abaissen l’e o
cogni i su de la ges co pus g âce à des s uc u es e blocs dédiés [9,22,27].
Les poin s posi i s e a en es se concen en su la lisibili é en clai , l’adop ion la ge e la
po abili é mul i o ma , mais les u ilisa eu s eulen une combinaison de simplici é Ma kdown
e de ichessed’AsciiDoc/ eST, no ammen admoni ions, ableaux, a iables, mac ose sys ème
d’inclusion, in ég és sans HTML b u [8,22,24,31]. L’ex ensibili é pensée pou la publica ion e
la con e sion e s HTML, EPUB, PDF ou DocBook es app éciée, su ou quand elle s’adosse
à un con e isseu pi o documen é e sc ip able [4,5,9]. La lisibili é en ex e b u es e un
c i è e cen al pou la collabo a ion, la elec u e e l’onboa ding de con ibu eu s hé é ogènes
[6,8].
Les ecommanda ionsquiendécoulen con e gen e sunnoyausyn axiqueminimalcomplé é
pa des modules op ionnels pou mon e en puissance, a in de p ése e la simplici é ou en
cou an admoni ions, é é ences c oisées, impo s, a iables e mac os, a ec une syn axe
concise e uni o me pou ableaux, lis es e blocs dédiés [9,22,24,31]. L’a chi ec u e de ai
3 / 30
ê e modulai e ia plugins e blocs pe sonnalisés, ga an i des con e sions idèles e s HTML,
PDF e EPUB, ha monise la syn axe des liens e employe des ma queu s explici es pou
les opé a ions ambiguës, ou en conse an la lisibili é en clai [4,6,20]. La discipline de
s anda disa ion, sou enue pa es s d’accep a ion e TCK en in ég a ion con inue, es iden i iée
comme le ie majeu pou limi e la dé i e des a ian es e sécu ise l’écosys ème ou illé, y
comp is dans des lux spec-d i en a ec LLM [23,25,29].
Les choix u ilisa eu s e lè en un a bi age coû s-béné ices en e «simplici é e adop ion» e
«puissance e s uc u e» : Ma kdown es choisi pa dé au pou sa popula i é e ses in ég a ions
pla e o mes, alo s qu’AsciiDoc es mobilisé pou les manuels e publica ions s uc u ées mal-
g é l’ins alla ion d’ou ils spéci iques ; la décision dépend de la cou be d’app en issage, de la
p é isualisa ion, de la po abili é, de la compa ibili é a ec les wo k lows e de la collabo a ion
[8,26,27]. Ce cons a alimen e un pa adoxe : le langage le plus populai e n’es pas le mieux
adap é à la documen a ion echnique a ancée, les eins à l’adop ion de langages plus obus es
é an su ou o ganisa ionnels e cogni i s, d’où l’in é ê d’un noyau minimal modulai e e
d’une no malisa ion explici e des ex ensions [6,9,20].
Su le plan cogni i , des ma queu s isibles e des s uc u es uni o mes éduisen la cha ge
men ale e acili en l’adop ion, andis que les admoni ions e blocs dédiés amélio en la
signalé iquedel’in o ma ionc i ique ;desmécanismesdepo abili é elsque a iables,mac os
e includes simpli ien la main enance e la éu ilisa ion à l’échelle des dépô s [4,8,24]. La
eche che u u ede ai analyse desco pusplusla gese desp a iquesd’en ep isesen«docs-
as-code», quan i ie la cha ge cogni i e selon les LML chez no ices e expe s, e mesu e l’e e
de la s anda disa ion su l’e icaci é d’équipe e la quali é documen ai e [26,32,33].
Les limi es echniques e onc ionnelles appellen une spéci ica ion unique e s able qui em-
pêche la dé i e dialec ale en dé inissan igou eusemen chaque onc ionnali é e en associan
un banc de es s public, à l’image des déma ches CommonMa k, GFM e AsciiDoc-Lang [6,20,
23]. Les chaînes T
E
X/L
A
T
E
X sou en de compila ions mul i-passes coû euses su g os documen s,
e un LML mode ne de ai ise une compila ion e icace e inc émen ale a ec des diagnos ics
clai s, dans un esp i de éac i i é p oche des pipelines con inus obse és dans les oolchains
con empo aines [10,11,12]. L’accessibili é es e insu isan e pa dé au : p odui e des so ies
con o mes WCAG e PDF/UA demande aujou d’hui des in e en ions spéci iques, d’où la néces-
si é d’in ég e na i emen un balisage, des s uc u es e des mé adonnées A11Y-compa ibles de
bou en bou [15,16,18]. Le suppo de domaines comme ma héma iques, chimie ou musique
doi équilib e exp essi i é e simplici é ; une in ég a ion p op e des o mules, bibliog aphies e
igu es, a ec é en uelle déléga ion calcula oi e con ôlée, é i e la dépendance à des modules
ex e nes ad hoc [34,35,36]. En in, un LML ondé su une g ammai e o melle décla a i e e
un Abs ac Syn axe T ee (AST) in e médiai e acili e pa seu s obus es, lin ing, con e sions e
alida ions, comme l’illus en les a aux su g ammai es o melles e MCSG pou langages
«nex -gen» [29,37,38].
Les limi es séman iques découlen du mélange équen en e p ésen a ion e con enu en L
A
T
E
X
e du sous-balisage séman ique en Ma kdown ; un LML de ai p opose des ôles e s yles nom-
més pou anno e code, noms p op es, e mes de glossai e, équa ions e obje s mul imédias,
ce qui es cohé en a ec les exigences d’accessibili é e de es i u ion assis ée [9,16,24]. Les
s uc u es de hau ni eau ( igu es a ec légende e ex e al e na i , ableaux i és, é é ences
c oisées d’obje s numé o és) doi en exis e dans un modèle uni ié, au-delà des di ec i es
4 / 30
p op es à chaque ou il [8,9]. Un mécanisme no mé de mé adonnées e de données emba -
quées, compa ible a ec les on -ma e usuels e expo able en JSON, a o ise in e opé abili é
e éu ilisa ion [4,5]. La possibili é de ma que des exp essions comme calculables, ou d’in o-
dui e des champs in e ac i s, ou e la oie à des documen s ac i s cô é HTML ou en es an
s a iques cô é a chi age [34,36].
Les limi es e gonomiques plaiden pou é i e la « soupe syn axique» e imposen une seule
o me pa in en ion, une syn axe au o-explici e e lisible en clai , sans dépendance à un en i-
onnemen spécialisé, ou en o an des édi eu s en ichis acul a i s e des messages d’e eu
p écis [7,17,38]. Des diagnos ics au momen de la édac ion, une documen a ion no ma i e
accompagnée de u o iels e d’exemples, e des alida eu s in ég és à l’ou illage CI en o cen
l’adop ion e la quali é globale [4,6,23].
En syn hèse, ces cons a s jus i ien la c éa ion de quickDoc : un langage à noyau minimal, mo-
dulai e, o mellemen spéci ié e es é, lisible en clai , ex ensible pa p o ils con ôlés, cou an
na i emen les blocs s uc u an s, l’accessibili é, la séman ique e la po abili é mul i o ma ,
e aligné a ec des wo k lows spec-d i en compa ibles LLM [6,16,23,24,25].
4 Exigences du langage
Su la base des analyses p écéden es, le p ésen chapi e o malise les exigences du langage
quickDoc. Chaque exigence (
REQ.NN
) exp ime un objec i géné al e chaque spéci ica ion
(
SPEC.NN.MM
) dé aille les condi ions de sa is ac ion co espondan es. Les es s e ègles
associées se on dé i és de ces spéci ica ions.
4.1 Fonc ionnali és ondamen ales
REQ.01
quickDoc doi o i un ensemble comple de mises en o me ex uelles dans une
syn axe uni iée e non ambiguë.
SPEC.01.01
Les élémen s de mise en o me comp ennen au minimum : i es hié a -
chiques, emphases, g as, i alique, souligné, ba é, exposan , indice, su lignage e
commen ai es in isibles.
SPEC.01.02
Une seule syn axe doi exis e pou chaque opé a ion donnée a in d’é i e
la mul iplici é de no a ions obse ée dans Ma kdown e ses a ian es [6,20,21].
SPEC.01.03
Les ma queu s doi en ê e explici es, lisibles e cohé en s su l’ensemble
du langage a in de limi e la cha ge cogni i e de l’u ilisa eu [22,38].
REQ.02
quickDoc doi in ég e les élémen s s uc u és nécessai es à la p oduc ion de docu-
men s echniques, scien i iques e édi o iaux.
SPEC.02.01
Figu es e images doi en pou oi ê e insé ées a ec légende, ex e al e na-
i e anc age logique dans la s uc u e du documen .
SPEC.02.02
Les ableaux doi en compo e i e, légende, en- ê es explici es e ê e
na igables pa les echnologies d’assis ance [9].
SPEC.02.03
No es de bas de page e ema ques en ma ge doi en ê e gé ées na i e-
men , a ec possibili é de placemen con igu able.
5 / 30
SPEC.02.04
Ci a ions bibliog aphiques e é é ences c oisées in e nes (sec ions, igu es,
équa ions, lis ings) doi en ê e au oma iques e main enues à jou lo s de la com-
pila ion.
SPEC.02.05
Les admoni ions (a e issemen s, exemples, ema ques) doi en ê e in é-
g ées dans le cœu du langage [24].
REQ.03
quickDoc doi pe me e l’inclusion e la ges ion de données s uc u ées à l’in é ieu
d’un documen .
SPEC.03.01
Les mé adonnées documen ai es ( i e, au eu , da e, licence, ésumé, mo s-
clés) doi en ê e exp imées dans un bloc s anda d de ype on -ma e .
SPEC.03.02
Les données applica i es ( ableaux, a iables, pa amè es) doi en ê e
décla ables, accessibles e éu ilisables dans le co ps du documen [4].
SPEC.03.03
L’expo JSON ou YAML des mé adonnées e des s uc u es de documen
doi ê e ga an i pou in e opé abili é a ec d’au es sys èmes (pa ex. doc-as-code,
pipelines CI/CD).
REQ.04
quickDoc doi pe me e la p oduc ion de documen s ep oduc ibles in ég an code
e ésul a s.
SPEC.04.01
L’inclusion de blocs de code (Py hon, R, Julia, Bash, e c.) doi ê e possible
a ec syn axe clai e.
SPEC.04.02
Un pa amè e doi dé ini si ces blocs son exécu és ou non lo s de la com-
pila ion.
SPEC.04.03
Les ésul a s d’exécu ion doi en ê e au oma iquemen insé és au bon
emplacemen ( ex e, ableau, g aphique).
SPEC.04.04
Le compo emen doi ê e aligné a ec les p incipes du li e a e p og am-
ming e des wo k lows ep oduc ibles [1,2].
REQ.05 quickDoc doi gé e na i emen les exp essions ma héma iques e leu é alua ion.
SPEC.05.01
Les o mules doi en ê e exp imées dans une syn axe ex uelle clai e, com-
pa ible a ec L
A
T
EX ou AsciiMa h.
SPEC.05.02
Ce aines o mules peu en ê e ma quées comme « calculables» e é a-
luées ia un sol eu symbolique ex e ne (CAS).
SPEC.05.03
Les g aphiques ou cou bes issus d’une o mule doi en pou oi ê e insé és
au oma iquemen .
SPEC.05.04
Les ésul a s numé iques doi en ê e o ma és selon les ègles de locale e
de ypog aphie scien i ique [35,36].
REQ.06 quickDoc doi in ég e une ges ion bibliog aphique s anda disée.
SPEC.06.01
Le sys ème de ci a ion doi ê e compa ible a ec CSL-JSON, BibTeX e Bi-
bLaTeX.
SPEC.06.02
Le s yle bibliog aphique doi ê e sélec ionnable pa mi la collec ion CSL
exis an e.
SPEC.06.03
Lesbibliog aphies doi en ê egéné ées au oma iquemen e éac ualisées
à la compila ion [4,33].
REQ.07 quickDoc doi dispose d’un mécanisme d’ex ension con ôlé.
SPEC.07.01
L’u ilisa eu peu dé ini des mac os nommées pou au oma ise mo i s e
cons uc ions écu en es.
SPEC.07.02
Les mac os ne doi en pas al é e la g ammai e de base ni omp e la com-
pa ibili é in e -documen s.
6 / 30
SPEC.07.03
Le sys ème d’ex ension doi ê e audi able e documen é (mani es es, dé-
pendances, e sionnage) [23,25].
4.2 S uc u e, séman ique e modélisa ion
REQ.08 quickDoc doi dispose d’une g ammai e o melle publiée e s able.
SPEC.08.01
La syn axe doi ê e déc i e en EBNF e les s uc u es de données documen-
ées ia schémas JSON.
SPEC.08.02
Tou changemen de e sion doi main eni la é ocompa ibili é ou ou ni
un mécanisme de mig a ion au oma ique [29,37].
SPEC.08.03
Un AST (Abs ac Syn ax T ee) o mel doi ê e dé ini pou pe me e les
ans o ma ions, lin ing e con e sions e s d’au es o ma s [38].
REQ.09 quickDoc doi pe me e une anno a ion séman ique iche du con enu.
SPEC.09.01
L’u ilisa eu doi pou oi ma que les en i és ex uelles pa ôle : e me
echnique, code, nom p op e, ab é ia ion, ac onyme, e c.
SPEC.09.02
Les o mules, igu es, ableaux e ci a ions doi en ê e ypées dans le mo-
dèle de données (ex. igu e scien i ique, g aphique s a is ique).
SPEC.09.03
Les anno a ions doi en ê e exploi ables pou l’accessibili é, la géné a ion
de mé adonnées e la na iga ion con ex uelle [16,39].
REQ.10 quickDoc doi pe me e la modula isa ion e la composi ion documen ai e.
SPEC.10.01
Le langage doi inclu e des di ec i es d’inclusion ou d’impo pou ag ége
des ichie s pa iels.
SPEC.10.02 La compila ion doi econs i ue l’a bo escence logique du documen glo-
bal.
SPEC.10.03
Les inclusions doi en pou oi ê e pa amé ées (chemins ela i s, a iables
d’en i onnemen ).
REQ.11 quickDoc doi ga an i la cohé ence hié a chique e logique des s uc u es.
SPEC.11.01 Les i es doi en sui e une hié a chie con inue sans sau de ni eau.
SPEC.11.02
Les lis es, ableaux e igu es doi en ê e insé ables dans n’impo e quelle
sec ion sans al é e la s uc u e.
SPEC.11.03
Les é é ences in e nes doi en ê e ésolues de maniè e dé e minis e e
é i iées à la compila ion.
4.3 Accessibili é, e gonomie e cogni ion
REQ.12
quickDoc doi ga an i la p oduc ion de documen s accessibles sans pos - ai emen
manuel.
SPEC.12.01
Lesso iesPDFdoi en ê econ o mesPDF/UAe lesso iesHTMLcon o mes
WCAG 2.1 AAA [15,16].
SPEC.12.02
Chaque élémen non ex uel (image, g aphique, audio, idéo) doi compo -
e un ex e al e na i ou une ansc ip ion.
SPEC.12.03
Les s uc u es logiques ( i es, lis es, ableaux) doi en ê e balisées séman-
iquemen pou la na iga ion assis ée.
7 / 30
SPEC.12.04
Les o mules ma héma iques doi en ê e expo ées en Ma hML ou do ées
d’é ique es a ia-label.
REQ.13 quickDoc doi o i une syn axe isuellemen clai e e cogni i emen homogène.
SPEC.13.01
Les ma queu s de mise en o me doi en ê e isibles, non ambigus e
uni o mes dans ou le langage.
SPEC.13.02
Une seule no a ion pa onc ion doi exis e pou é i e les a ia ions dia-
lec ales.
SPEC.13.03
La lisibili é en ex e b u doi ê e conse ée; ou documen quickDoc doi
es e comp éhensible sans endu [8,38].
REQ.14 quickDoc doi ê e simple à app end e e à u ilise .
SPEC.14.01
Un u ilisa eu no ice doi pou oi édige un documen basique en moins
d’une jou née.
SPEC.14.02 La documen a ion doi ê e clai e, complè e e illus ée d’exemples.
SPEC.14.03
Chaque ajou syn axique doi se jus i ie pa un gain explici e de lisibili é
ou de puissance exp essi e [26,27].
REQ.15 quickDoc doi a o ise la collabo a ion e la elec u e.
SPEC.15.01
Les documen s doi en pou oi ê e e sionnés e compa és ligne à ligne
dans un VCS (Gi ).
SPEC.15.02
Des ma queu s de commen ai es ou sugges ions doi en ê e p é us pou
l’anno a ion collabo a i e.
SPEC.15.03 Le o ma ex e clai doi pe me e la e ue sans ou il spéci ique [26,40].
4.4 Po abili é, pe o mance e sécu i é
REQ.16 quickDoc doi p odui e plusieu s o ma s de so ie s anda disés.
SPEC.16.01
Géné e au minimum : PDF/A-3, PDF/UA, HTML5 + ARIA, EPUB 3, ODT e L
A
T
E
X.
SPEC.16.02
Le con enu expo é doi conse e la s uc u e logique e les mé adonnées.
SPEC.16.03
Les con e sions doi en ê e con ôlées ia une couche d’abs ac ion (AST
→backend).
SPEC.16.04 Chaque backend doi ê e es able pa une sui e de con o mi é [4,5].
REQ.17 quickDoc doi ê e in e opé able e acilemen in ég able.
SPEC.17.01 Fou ni un compila eu open-sou ce (licence CeCILL-C).
SPEC.17.02
Publie une Applica ion P og amming In e ace (API) publique pe me an
d’u ilise le pa seu e de manipule l’AST.
SPEC.17.03
Me e à disposi ion une sui e de es s de con o mi é Beha io -D i en De e-
lopmen (BDD) (Cucumbe ) e un TCK.
SPEC.17.04
P é oi des con e isseu s bidi ec ionnels (Ma kdown ↔ quickDoc ↔ HTML)
[23,25].
REQ.18 quickDoc doi p ésen e de hau es pe o mances su de g ands documen s.
SPEC.18.01
La compila ion doi ê e inc émen ale, mul i- h ead e à consomma ion
mémoi e con ôlée.
SPEC.18.02
Un documen de 100 pages a ec igu es doi se compile en moins de deux
secondes su une machine s anda d.
SPEC.18.03
Les es s de cha ge doi en inclu e des cen aines de pages e plusieu s
8 / 30
dizaines de mégaoc e s d’images [10,12].
REQ.19
quickDoc doi ga an i la sécu i é lo s de l’exécu ion de code ou du cha gemen de
essou ces.
SPEC.19.01 Pa dé au , aucun code inclus ne doi ê e exécu é.
SPEC.19.02 Le mode d’exécu ion doi ê e explici emen ac i é pa l’u ilisa eu .
SPEC.19.03
Lesliensex e nesnedoi en pasê echa gésau oma iquemen sanscon i -
ma ion.
SPEC.19.04
Les con igu a ions d’excep ion doi en ê e en egis ées dans un mani es e
de sécu i é.
REQ.20 quickDoc doi assu e la compa ibili é linguis ique e ypog aphique uni e selle.
SPEC.20.01
Suppo comple d’Unicode, y comp is alphabe s non la ins, symboles
scien i iques e émojis.
SPEC.20.02
Ges ion mul ilingue e ypog aphie locale (espacemen , guilleme s, ponc-
ua ion).
SPEC.20.03 Les ci a ions e é é ences doi en espec e la locale sélec ionnée.
4.5 Gou e nance, ex ensibili é e pé enni é
REQ.21 quickDoc doi ê e gou e né selon un modèle ou e e anspa en .
SPEC.21.01
La spéci ica ion, les es s e les schémas doi en ê e publiés sous licence
lib e.
SPEC.21.02
Les é olu ions doi en ê e déba ues publiquemen e alidées pa e sion
no ma i e.
SPEC.21.03
Les changemen s syn axiques majeu s doi en ai e l’obje d’une pé iode
de ansi ion documen ée [23].
REQ.22
quickDoc doi o i un sys ème de plugins s anda disé pou é end e ses onc ionnali-
és.
SPEC.22.01
Lesex ensions(ex.nou eauxlangagesdecolo a ion,expo s, il es)doi en
pou oi ê e ajou ées sans modi ie le cœu du compila eu .
SPEC.22.02
Un egis e o iciel de plugins alidés doi ê e main enu pou ga an i l’in-
e opé abili é.
SPEC.22.03 Les API d’ex ension doi en ê e s ables e documen ées [23,25].
REQ.23 quickDoc doi assu e la pé enni é des documen s p odui s.
SPEC.23.01
Les documen s doi en ê e a chi ables selon les o ma s ou e s (PDF/A,
HTML, Ma kdown).
SPEC.23.02
Les dépendances du langage (polices, modules) doi en ê e explici emen
lis ées pou ga an i la econs uc ion u u e.
SPEC.23.03
Un ou il de alida ion doi pou oi é i ie la con o mi é syn axique e
séman ique d’un documen ancien a ec une e sion donnée du langage.
9 / 30
5.5.8 Code
Code
délimi eu
`
(back ick)en ou an unmo ouuneph asedecode.Exemple:
`p in ("hello")`
donne a un
<code>
en monospace. Pou inclu e un back ick li é al dans du code, on
pou a u ilise
`` ``
(deux back icks en ou an le code si celui-ci con ien déjà un
back ick). C’es la même ègle que Ma kdown é endu.
Un bloc a ichan du code sou ce b u . En quickDoc, on adop e la syn axe de ences (clô u es)
similai es à Ma kdown : ois accen s g a es ou an s déclenchen un bloc de code jusqu’à
encon e ois accen s g a es e man s. Ap ès les ini iaux, il es possible d’indique des pa a-
mè es sous la o me {se key: al ...} su la ligne sui an e.
```{<pa ame es>}
<code su
plusieu s
lignes>
```
Ceci indique un bloc de code en Py hon, à exécu e (
play: ue
), e à expo e à la ois le
code e le ésul a (expo :bo h). Les pa amè es de bloc de code disponibles incluen :
—lang (langage pou colo a ion syn axique, ex : py hon,ja a,shell, e c.),
—play (exécu ion au o isée = ue/ alse),
— un ime
: mo eu ou in e p é eu spéci ique si besoin, ex : node ou deno pou Ja aSc ip ,
—expo : choix en e e ba im, esul ,bo h,nei he .
Si
play
n’es pas
ue
, le code n’es pas exécu é e seul le code b u es a iché (comme un
exemple s a ique). Le ésul a d’un bloc exécu é peu ê e du ex e, une image (g aphique), un
ableau, e c., qui se a insé é à l’emplacemen du bloc.
Les blocs de codes peu en ê e con igu e de maniè e à ob eni plusieu s compo emen s.
Les pa amè es son à insc i e sous la o me
[[[se <pa ame e -name>:< alue>]]]
a ec les pa ame es sui an s :
—lang : dé ini le langage u ilisé pou le o ma age du ex e,
— un ime
: dé ini le mo eu d’éxecu ion le cas échéan e si pe inen (e.g. deno, node, bun,
e c.).
—play : au o ise l’execu ion du code a ec e l’empêche pa dé au (nil).
—expo
: p écise ce qui doi ê e imp imé lo s de l’expo . Ce pa amè e peu p end e
spéci iquemen les aleu s sui an es :
— e ba im
: imp ime le code en police monospace a ec son o ma age e colo a ion
syn haxique,
— esul
: emplace le bloc de code a ec son ésul a (e.g. un g aphique, un ableau,
e c.),
—bo h : imp ime successi emen le code en e ba im puis son ésul a ,
—nei he : n’imp ime ien.
16 / 30
```{se lang:py hon expo : esul }
impo ma plo lib.pyplo as pl
pl .plo ([1, 2, 3], [4, 5, 6])
pl .show()
```
Lis ing 2 : Exemple de bloc de code comple
FIGURE 1 : Résul a de l’exemple
17 / 30
5.5.9 Ma héma ique
Pou les o mules display (isolées au cen e). LML u ilise égalemen une clô u e dédiée, pa
exemple
$$$
en débu e in de bloc (analogue à
$$ ... $$
en L
A
T
E
X, mais su plusieu s
lignes). En e ces délimi eu s, on place la o mule en no a ion LML ( ès p oche de la syn axe
L
A
T
E
X ma h). Des pa amè es peu en égalemen ê e ou nis ap ès les
$$$
ini iaux ia
{se
...}, no ammen :
—
sol e pou spéci ie unsol eu sionsouhai equela o mulesoi calculée(ex:sol e :sympy),
—
é en uellemen d’au es pa amè es comme le o ma d’a ichage du ésul a (exac s
numé ique, nomb e de décimales, e c. – ces dé ails pou on é olue ).
Si un sol eu es indiqué, la o mule se a ansmise à ce sol eu e son ésul a (pa ex. simpli i-
ca ion ou aleu numé ique) pou a ê e insé é soi en sus, soi à la place, selon le con ex e. Pa
dé au , sans sol e , la o mule es endue elle quelle en no a ion ma héma ique.
$$${<pa ame es>}
< o mule ma héma ique
su plusieu s
lignes>
$$$
Les blocs de ma héma iques peu en ê e associées à un ésol eu d’équa ion el que :
$$
[[[se sol e :<nom du ésol eu >]]] <equa ion>
Quelques exemples de é-
sol eu s : Ma h.js, SymPy, Maxima, SageMa h, Wol am Alpha, e c.
5.5.10 Commen ai e
Commen ai e
délimi eu
;
(poin - i gule) pou me e un cou commen ai e non isible
dans la so ie, au sein d’une ph ase. Ex :
;No e in e ne;
se a complè emen omis à
l’expo .
quickDoc pe me des commen ai es de l’au eu qui ne se on pas endus dans la so ie inale.
Ceux-ci son no é pa
;;;
en débu de bloc e
;;;
en in. Tou ex e à l’in é ieu es igno é
lo s du endu. Al e na i emen , un double poin - i gule
;;
en débu de ligne peu ma que un
commen ai e su la ligne en iè e (no ammen dans un bloc de code, pou commen e du code
qui ne se a pas exécu é).
Des commen ai es en ichis son possibles ia des pa amè es ype : su le bloc de commen ai e.
Pa exemple ype: odo ou ype: odo-inline pou signale une âche à ai e. Cela pou a se
adui epa unenca ”TODO” isibledanslePDF/HTML,é en uellemen danslama geoudans
le lux du ex e. Ceci es u ile en phase de édac ion (pou indique des sec ions incomplè es,
e c.).
;;;{<pa ame es>}
<commen ai es
su plusieu s
18 / 30
lignes>
;;;
Les blocs de commen ai es son de 4 ypes :
— sans p écision, ils ne son pas expo ées
—
a ec
ype: odo-inline
ils imp imen un bloc de ype ”TODO” en lieu e place en que
celui ci :
bloc ”TODO” en ligne
—
a ec
ype: odo
ils imp imen un bloc de ype ”TODO” dans la ma ge du documen el
que celui ci :
e.g.
5.5.11 P op ié és
Un bloc de p op ié é pe me d’a ache des mé adonnées à ou au e bloc.
— inline : {ge /se p op: alue}
— mul iline : {{{ge /se p op: alue}}}
Associe des p op ié és à un bloc de ex e :
Ceci es un bloc de ex e a ec des p op ié ées a achées.
{{se ype:p ope ies key1: alue1 key2: alue2}}
Les p op ié és peu en ê e u ilisés pou collec e des en ées u ilisa eu s e c ée des o mu-
lai es en éc i an
{ge <p ope y> <key>:< alue>}
où
<key>
co espond au ype
a endu e
< alue>
co espond à la con ain e associée. Pa exemple, oici des appels d’en-
ées alides :
—{ge use -name s ing:20}:
donne a
____________________
e se a a ec é
à la p op ié é ”use -name”,
—{ge use -lang s ing:2} donne a __ e se a a ec é à la p op ié é ”use -lang”.
Lesdécla a ionsdep op ié ésmonolineson dela o me
{{ge /se p op: alue}}
.Elles
son pa iculiè emen adap éesà la décla a ion de la mise en page du documen (aligmnemen
du ex e, mise en colonne des blocs, e c.). Ces opé a ions se éalisen en deux é apes :
1. Dé ini une mise en o me el que :
{{se ex _s yle name:pa aghaphe scope: aw- ex al:jus i size:12 long:80cha colo :black on :sou ce-
sans-p o columns:nil}}
2. L’applique el que :
{{use ex -s yle name:pa ag aphe}}
La mise en o me se a appliquée à pa i de sa décla a ion (
use
) jusqu’à la décla a ion d’un
au e s yle.
19 / 30
5.5.12 Tableau
La syn axe des ableaux peu s’inspi e soi de Ma kdown ( abula ion pa des
|
), soi d’AsciiDoc
(lignes e colonnes sépa ées pa
|
e o ma age a ancé ia des cellules d’en ê e
!
e c.). Une
ligne d’en- ê e op ionnelle, encad ée de
|
e sépa an les cellules pa
|
. Une ligne de sépa a ion
en-dessouscomposée de
|- - -|
(aumoins 3 i e sen echaque
|
)indique la inde l’en- ê e.
Puis les lignes de co ps du ableau, a ec la même syn axe de cellule sépa ées pa |.
| Colonne A | Colonne B |
|-----------+-----------|
| Valeu A1 | Valeu B1 |
| Valeu A2 | Valeu B2 |
Les cellules peu en con eni du ex e o ma é (i alique, e c.)
mais pas de blocs mul iples (pas
de i e ou lis e à l’in é ieu d’une cellule, sau en u ilisan é en uellemen des as uces non
cou e es ici).
La po ée de ce e spéci ica ion de ableau es
limi ée aux usages simples de
ype CSV mis en o me.
Les aspec s plus complexes ( usion de cellules, ableaux imb iqués)
ne
son pas gé és na i emen pa LML 1, mais pou aien ê e ajou és ia des ex ensions.
5.5.13 Bloc séman ique
u ilise les </>
5.5.14 Mul imédia
L’inse ion d’une image se e a ia une di ec i e de lien spécialisée ( oi 5.6 su les liens).
Tou lien e s un ichie image (ex :
[[img:chemin/ igu e.png]]
) insè e l’image dans le
documen . Pou ajou e une légende, on pou a encapsule ce e image dans un bloc de igu e,
pa exempleenla p écédan d’un i ede igu eouenu ilisan unemac odédiée.Une app oche
consis e à ai e une image insé ée isolée a ec un ex e de légende sui an immédia emen
comme une igu e g oupée. Pa exemple :
[[img:diag ams/schéma1.s g]]
{{{se
id:img1
i le:"P ocessus illus é"
al - ex :"Schéma illus a i du p ocessus"
desc ip ion:"Une desc ip ion ac uelle de l'image"
}}}
5.5.15 Snippe s
( agmen s éu ilisables) mécanisme pe me an d’injec e du con enu ou des é é ences (ex.
inclusion de la aleu d’une p op ié é).
20 / 30
Tous les blocs de ex es peu en ê e associées à des ags. Un ag s’éc i
#< ag>
peu ê e
insé ée à n’impo e quel end oi du bloc de ex e en espec an les êgles de balisage déc i es
au pa ag aphe 5.7.
TABLE 2 : lis e des snippe s
Type Lemma Beha io
Re Link @elemen Insè e un [[lien]] unidi ec ionnel
Tag # ag Insè e un [[lien]] bidi ec ionnel
Les ags son u ilisés pou ai e de l’analyse séman ique. Ec i e un ag en aine la c éa ion ou la
mise à jou d’un ichie ” ag_<nom-du- ag>.qdo” cons i ué comme ceci :
# Nom-du- ag
[[[ge coun :?]]] ;; nomb e d'occu ence dans le p oje
[[[ge blocs:?nom-du- ag]]] ;; ous les blocs u ilisan s le ag
L’ins uc ion
[[[ge blocs:?nom-du- ag]]]
peu ê e complé é pa un sys ème de is.
Pa exemple,pou lis e lesblocspa o d ededa edéc oissan eonéc i a
[[[ge blocs:?nom-
du- ag o de -by:da e-desc]]].
Unsys èmede âmepe me an auxu ilisa eu sdep écon igu e cesdocumen se demodi ie
en lo leu s con igu a ion se ai un a oû en ma iè e d’expé ience u ilisa eu .
Les snippe s son une onc ionnali é hé i ée no ammen de quickDoc, pe me an d’insé e
dynamiquemen descon enusgéné ésoude é é ence desélémen s ans e sesdudocumen .
Ils se p ésen en sous o me de balises iple-c oche s a ec mo -clé, pa exemple
[[[ge
...]]] ou [[[se ...]]].
5.5.1 [[[se ...]]] – dé ini ion de p op ié é ou con igu a ion
La balise se es u ilisée soi en ê e de documen pou dé ini des s yles/con ig globales, soi
au sein de blocs (comme u plus hau ) pou pa amé e un bloc spéci ique (langage d’un code,
ype d’admoni ion, e c.). En géné al,
[[[se X:Y ...]]]
signi ie «assigne la p op ié é
X a ec la aleu Y». Pa exemple :
[[[se colo :blue]]]
. Dans le cas des blocs, ce e
ins uc ion appa aî immédia emen ap ès l’ou e u e du bloc (comme illus é pou les blocs
de code, de ma hs, e c.). Dans le cas d’une con igu a ion globale, on peu l’u ilise soi dans
le on -ma e , soi su une ligne spéciale au débu du documen é en uellemen in odui e
pa un commen ai e. QuickDoc mon ai une inclusion de ichie de con ig ia
;;[[[se
con ig ile:...]]]
,LML pou a a oi plus simplemen dans le on -ma e une sec ion
dédiée pou impo e des con igs.
En ésumé,
[[[se ...]]]
n’es pas exac emen un snippe insé é dans le ex e inal, mais
une di ec i e de églage a ec an le endu ou le compo emen .
5.5.2 [[[ge ...]]] – inse ion de con enu géné é
La balise ge pe me de écupé e une aleu ou un con enu calculé. On l’u ilise au sein du
ex e pou insé e , pa exemple, la aleu d’un comp eu , d’une p op ié é, ou le ésul a d’une
equê e. Syn axe géné ale : [[[ge <sou ce> <clé>:< il e>]]].
21 / 30
Exemples en isagés :
[[[ge coun :?]]]
pou ai en oye un nomb e, pa ex. le nomb e d’élémen s co es-
pondan à une equê e ( oi plus bas).
[[[ge blocs:? ag]]]
pou insé e la lis e de ous les blocs aggés pa # ag (no ion de
ag abo dée en 5.5.3).
[[[ge p ope y nom]]]
pou insé e la aleu d’une p op ié é de mé adonnée nom-
mée nom dé inie dans le documen (pa ex. l’au eu ou le i e).
[[[ge da e:now]]] pou la da e du jou , e c., ou d’au es onc ions.
LML de a dé ini une lis e de sou ces accessibles ia ge : coun (comp eu s), blocs (collec ion
de blocs épondan à un c i è e), p ope y/me a (mé adonnées), possiblemen en ( a iables
d’en i onnemen ou a gumen s de compila ion), e c.
Des il es ou pa amè es peu en a ine la equê e, p. ex.
[[[ge blocs:? ag o de -
by:da e-desc]]]
pou ie les blocs aggés pa da e déc oissan e. Ce mécanisme puissan
app oche LML d’un ou il de ges ion de connaissances, pe me an de géné e des index, des
ables des ma iè es, des lis es de âches au oma iques, e c.
5.5.3 Tags e é ique age séman ique
En LML, on au o ise l’ajou de ags à n’impo e quel bloc de ex e pou une classi ica ion
séman ique. Un ag s’éc i
#mo cle
di ec emen dans le ex e ou en p é ixe d’un bloc. Pa
exemple :
#TODO
au débu d’une ligne de lis e de âche, ou
#impo an
dans un pa ag aphe.
Ces ags ne son pas a ichés dans le endu inal, ou é en uellemen ans o més en élémen s
isuels disc e s, mais su ou ils alimen en une indexa ion in e ne.
L’u ilisa ion de ags combinée à
[[[ge blocs:? ag]]]
pe me de géné e pa exemple
un index de ous les blocs ma qués d’un ag pa iculie . On peu s’en se i pou : lis e des
TODO es an s, index héma ique, glossai e ( ag
# e me
su la dé ini ion d’un e me), e c.
Ce e app oche en ai un langage plus séman ique e o ien é ges ion de connaissances.
Techniquemen , LML pou ai c ée en coulisse des ichie s ou des sec ions in isibles où son
lis és les con enus pa ag (comme quickDoc suggè e un ichie ag_nom.qdo géné é pou
chaque ag). La spéci ica ion peu es e au ni eau concep uel (il n’es pas nécessai e de no me
commen c’es implémen é, jus e que le ésul a es comme si un el index exis ai ).
5.5.16 Callou s
Les callou s son des liens bidi ec ionnels à l’in é ieu d’un documen e pe me en de cible
des blocs. Ils son u ilisés pou sau e apidemen à un con enu, une no e, une é é ence, e c.
5.5.17 Liens e é é ences
Les liens son ous di ec ionnels.
Ré é ence in e ne plusieu s ypes de callou s pe me en de c ée des liens in e nes :
22 / 30
TABLE 3 : Tex callou s
Type Lemma Beha io
Re e ence [ e :id]
Foo No e [ n:id]
Quo e [ci e:id]
Figu e e [ ig:id]
Table e [ bl:id]
Code e [s c:id]
Heade jump [head:id]
—[ e :ID]
pou é é ence géné ique à un élémen epé é pa l’iden i ian ID (sec ion,
igu e, e c.). Cela a iche a soi le numé o de l’élémen (ex : “Figu e 3”) soi un ex e
pa dé au .
—[ ig:ID] a iche “Figu e X” en lian e s l’image de nom ID.
—[ bl:ID] pou “Tableau X”.
—[eq:ID] (é en uellemen ) pou les équa ions numé o ées “(X)”.
—[s c:ID] pou é é ence un lis ing de code.
—[heade :ID] pou poin e e s le i e de sec ion iden i ié.
—[ci e:ID]
insè e un en ois e s la bibliog aphie e é é ence l’en ée bibliog a-
phique.
—[ n:ID]
—[ mq:ID]
Liens ex e nes
La syn axe géné ale des liens es
[[URL| ex e]]
ou
[[URL]]
si pas de
ex e(a iche al’URLb u eoula essou cein ég éesi econnu).Pa exemple:
[[h ps://example.com|si e
web]]
pou un lien hype ex e. Si le p o ocole es img : ou ile : ou au e, cela peu dé-
clenche des compo emen s spéci iques.
Tous les liens sui en l’éc i u e
[[<CONTEXT>:<LINK>]|[<TEXT>]]
pù seul le
<LINK>
doi ê e enseigné. Les au es élémen s son :
—<CONTEXT>
ou nisdesin o ma ionscomplémen ai espou l’a ichagedulien.Celape me
de me e en oeu e des a ichages adap és aux images, idéos, playe de musique, lux
RSS, e c.
—<LINK>
is he pa h o he esou ce on he Wo ld Wide Web, in a ile sys em, o on any
suppo ed ne wo k. We can call a ‘Heade ID‘ om he cu en documen o om ano he
one.
—<TEXT> es le ex e de emplacemen à a iche à la place du lien.
un lien peu ê e a aché à des p op ié és
{ge }
es u ilisé pou en oye e s une sec ion
pa iculiè e du lien (un i e, un callou , e c.).
{se }
es u ilisé pou décla e les élémen s de
desc ip ions e d’accessibili é.
Tag # ag
Men ion @some ing en ois à une pe sonne ou à une é ape d’un p ocessus
Radiolink [[[name]]]
c ée un lien dynamique con ex uel en oyan chaque men ions du
name du adiolien à la décla a io nde celui-ci.
23 / 30
TABLE 4 : <LINK> ypes
Type Lemma Can be used o
URI
Web URL [[h ps:link]] Display a bookma k
Local File [[ ile:<pa h>]]
Musique [[:<pa h o u l>]] Display a music playe
Image [[img:<pa h o u l>]]
Documen [[doc:<pa h o u l>]] Display a documen iewe
Video [[ id:<pa h o u l>]] Display a ideo playe
Heade ID [[id:heade Id]]
RSS Flow [[ ss:<u l>]] Display a lis o las en ies
IRC Flow [[i c:<u l>]] Display a lis o las messages
Email [[mail o:<email>]] Display a con ac o m
5.6 No mailsa ion e i18n
inse ion des espaces insécables associés au di e s élémen s au ega d des egles lexicales de
chaque langues (guilleme s, ci a ions, doubles-poin s, e c.)
5.7 Balisage
Lis s begins wi h a bulle s ha ep esen hei meaning ollowed by a space. The ollowing is
suppo ed :
— O de ed lis s s a s wi h 1.,
— Uno de ed lis s s a s wi h -,
— Heade s a e lis s oo and s a s wi h a #, he numbe o #se he le el o he heade .
Suble els (nes ed lis s) a e suppo ed o heade s, o de ed and uno de ed lis s. The e mus be
4 spaces be o e he suble el bulle .
The expo backend shall p o ide se ings o cus omise desi ed o ma ing ou pu s o o de ed
lis s (alpha-nume ic numbe ing, do s, pa en heses…)
6 Consis ency analysis
A consis en ligh weigh ma kup language shall ha e only one way o o ma ex .
Ma kdown a ian s on he 5a e limi ed o hose lis ed by IANA’s ”Ma kdown Va ian ” [21]. We
exclude SSW and Qua o, he i s one is oo con ex ual and he second is based on Pandoc
ma kdown.
— Bol : Bold
— I a : I alique
— O L : O de ed Lis
— UnL : Uno de ed Lis
— Und : Unde line
— Hig : Highligh
24 / 30
TABLE 5 : Tex o ma ing consis ency e sus Ma kdown a ian s
Fo ma Bol I a O L UnL Und Hig S Ve Cod Sup Sub Com
quickDoc 1 1 1 1 1 1 1 1 1 1 1 1
CMD[6]
MMD[31]
GFM[20]
Pandoc[4]
Foun ain[41]
MD o RFCs[42]
Pandoc2 c
MDX[43]
MyST[34]
AsciiDoc
eST
O g-Mode
Tex ile
Djo
Wiki ex
C eole
x 2 ags
Se ex
— S : S ike
— Ve : Ve ba im
— Cod : Inline code
— Sup : Supe sc ip
— Sub : Subsc ip
— Com : Commen
7 Capaci y analysis
8 Typesys em compa ibili y
9 Conclusion
25 / 30
