This repository has been archived by the owner on Jul 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
manuel-d-utilisation-cli.html
1337 lines (1285 loc) · 70.1 KB
/
manuel-d-utilisation-cli.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="fr">
<head>
<meta charset=utf-8 />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="generator" content="Eleventy v1.0.2">
<title>Manuel d’utilisation (CLI) | Cosma</title>
<meta name="description" content="Manuel d’utilisation de Cosma CLI." />
<meta name="author" content="Arthur Perret,Guillaume Brioudes" />
<meta name="copyright" content="GPL-3.0-or-later"/>
<meta name="last_edit" content="2023-04-21" />
<meta property="og:type" content="website" />
<meta property="og:title" content="Manuel d’utilisation (CLI)" />
<meta property="og:description" content="Manuel d’utilisation de Cosma CLI." />
<meta property="og:site_name" content="cosma-docs" />
<meta itemprop="name" content="cosma-docs" />
<meta itemprop="description" content="Manuel d’utilisation de Cosma CLI." />
<link rel="schema.DC" href="https://purl.org/dc/elements/1.1/" />
<link rel="schema.DCTERMS" href="https://purl.org/dc/terms/" />
<meta property="DC.title" content="Manuel d’utilisation (CLI)" />
<meta property="DC.contributor" content="Arthur Perret,Guillaume Brioudes" />
<meta property="DC.date" content="2023-04-21" />
<meta property="DC.language" content="fr" />
<meta property="DC.description" lang="fr" content="Manuel d’utilisation de Cosma CLI." />
<meta property="DC.rights" content="GPL-3.0-or-later" />
<meta name="twitter:site" content="@arthurperret" />
<meta name="twitter:creator" content="@arthurperret" />
<meta name="twitter:title" content="Manuel d’utilisation (CLI)" />
<meta name="twitter:description" content="Manuel d’utilisation de Cosma CLI." />
<meta name="twitter:card" content="summary" />
<meta name="twitter:image" content="https://cosma.graphlab.fr/img/cosma-icone.png" />
<style>
:root {
--sans: "Helvetica Neue", Helvetica, sans-serif;
--serif: "Georgia", 'Garamond', 'Time New Roman', 'Times', serif;
--mono: Menlo, Monaco, Consolas, "Courier New", monospace;
--code-background-color: #f5f5f5;
--code-border-color: #ccc;
}
/* LAYOUT */
* {
box-sizing: border-box;
}
body {
margin: 0;
padding: 0 1em;
line-height: 1.5;
max-width: 1000px;
margin: 0 auto;
font-family: var(--serif);
display: grid;
grid-template-columns: 70% 30%;
grid-gap: 0 1%;
grid-template-areas: "header header"
"main aside"
"footer footer";
}
header {
grid-area: header;
}
nav.nav-lang {
grid-area: headernav;
font-family: var(--sans);
}
.nav-lang ul {
display: flex;
justify-content: space-between;
list-style:none;
padding: 0;
margin-top: 1.8em;
}
main {
grid-area: main;
padding-bottom: 5vh;
}
/* HEADINGS */
header, h1, h2, h3, h4 {
font-family: var(--sans);
}
h2, h3, h4 {
line-height: 1.2;
padding-bottom: 0.2em;
font-size: 1.2em;
}
h2 {
border-bottom: 2px solid black;
}
h3 {
border-bottom: 1px solid #111;
}
main h2 {
font-size: 1.3em;
margin: 3.5rem 0 0.5rem 0;
}
main > h2:first-child {
margin-top: 0;
}
main h3 {
font-size: 1.2em;
margin: 3rem 0 0.3rem 0;
}
main h4 {
font-size: 1em;
margin: 2rem 0 0 0;
}
/* LINKS */
a {
color: #0056b3;
text-decoration: none;
}
a:hover {
color: #00448f;
text-decoration: underline;
}
:target { animation: highlight 3s ease; }
@keyframes highlight {
0% { background-color: #ffa; }
100% { background-color: #ffffff; }
}
/* TABLES */
table {
border-collapse: collapse;
margin: 2rem 0;
text-align: left;
width: 100%;
}
tr { border: 1px solid gray; }
th, td { border: 1px solid gray; padding: 0.5rem; }
/* LISTS */
ul, ol {
padding-left: 1rem;
}
dt {
font-family: var(--sans);
font-weight: bold;
float: left;
padding: 0 0.5rem 0 0;
line-height: 1.4;
}
dd {
padding: 0;
margin: 1rem 0 1rem 2rem;
}
/* MEDIA */
img {
max-width: 100%;
}
figure {
display: flex;
flex-direction: column;
align-items: center;
border: var(--accent-color) 1px solid;
padding: 15px 10px;
}
figcaption {
font-size: 0.8rem;
font-style: italic;
padding: 1rem 0 0 0;
}
/* ADMONITIONS */
.astuce, .tip, .note, .important {
position: relative;
background: rgb(225, 225, 225);
padding: 30px 10px 3px 10px;
border-radius: 5px;
margin: 1.5rem 0;
font-size: 0.9rem;
}
.astuce::before,
.tip::before,
.note::before,
.important::before {
content: attr(class);
position: absolute;
top: 5px;
left: 5px;
font-size: 12px;
font-family: var(--mono);
}
.astuce, .tip, .note {
background: rgb(225, 225, 225);
}
.important {
background: rgb(239,178,178);
}
/* CODE */
code, pre {
font-family: var(--mono);
}
code {
display: inline-block;
font-size: 90%;
}
p code,
ul code,
ol code,
dl code,
table code {
background-color: var(--code-background-color);
border-radius: 4px;
padding: 0 0.2em;
}
pre {
background-color: var(--code-background-color);
border: 1px solid var(--code-border-color);
border-radius: 4px;
padding-left: 0.5em;
margin: 1em 0;
overflow-x: auto;
}
/* ASIDE (TOC) */
aside {
grid-area: aside;
position: sticky;
height: 80vh;
top: 2em;
padding-left: 3em;
font-size: 0.875em;
font-family: var(--sans);
}
aside ul {
list-style-type: none;
}
aside > nav > ul > li {
position: relative;
padding-bottom: 0.75em;
}
aside .toggle {
cursor: pointer;
position: absolute;
left: -28px;
top: -2px;
padding: 2px 10px;
color: #0056b3;
}
/* FOOTER */
footer {
grid-area: footer;
}
/* DARK MODE */
/* Inspiré par Bradley Taunt */
/* https://tdarb.org/lazy-dev-dark-mode/ */
@media (prefers-color-scheme: dark) {
body {
background: #2d2d2d;
filter:invert(1);
}
a,
img,
pre,
*:not(pre) > code {
filter:invert(1);
}
aside .toggle {
color: #5e421b;
}
a {
color: #B2CCE8;
}
.astuce, .tip, .note {
background: #b4b4b4;
}
.important {
background: #67f3f4;
}
}
@media screen and (max-width: 1000px) {
body {
display: block;
max-width: 700px;
margin: 0 auto;
}
header > *,
main {
margin-right: auto;
margin-left: auto;
width: 100%;
}
main {
padding-bottom: 3vh;
}
aside {
position: relative;
height: auto;
padding-left: 5vw;
top: 0;
}
aside h1 {
display: block
}
.nav-lang ul {
justify-content: flex-end;
}
.nav-lang ul li {
padding-left: 1em;
}
}
</style>
</head>
<body>
<header>
<article>
<h1 class="title-site">Cosma — Manuel d’utilisation (CLI)</h1>
</article>
</header>
<aside id="toc">
<nav class="toc" >
<ul><li><a href="#installation-et-mise-a-jour">Installation et mise à jour</a><ul><li><a href="#installation">Installation</a></li><li><a href="#mise-a-jour">Mise à jour</a></li></ul></li><li><a href="#presentation">Présentation</a></li><li><a href="#la-commande-cosma">La commande cosma</a><ul><li><a href="#creer-le-repertoire-de-donnees-utilisateur">Créer le répertoire de données utilisateur</a></li><li><a href="#afficher-les-projets">Afficher les projets</a></li><li><a href="#afficher-le-numero-de-version">Afficher le numéro de version</a></li><li><a href="#afficher-laide">Afficher l'aide</a></li></ul></li><li><a href="#configuration">Configuration</a><ul><li><a href="#creer-un-fichier-de-configuration">Créer un fichier de configuration</a></li><li><a href="#creer-un-fichier-de-configuration-global-(projet)">Créer un fichier de configuration global (projet)</a></li><li><a href="#creer-un-fichier-de-configuration-par-defaut">Créer un fichier de configuration par défaut</a></li><li><a href="#parametres-de-configuration">Paramètres de configuration</a></li><li><a href="#modele-de-configuration">Modèle de configuration</a></li></ul></li><li><a href="#creer-du-contenu-fichiers-texte-(markdown)">Créer du contenu : fichiers texte (Markdown)</a><ul><li><a href="#metadonnees">Métadonnées</a></li><li><a href="#contenu">Contenu</a></li><li><a href="#liens">Liens</a></li><li><a href="#identifiants-uniques">Identifiants uniques</a></li><li><a href="#creer-des-fiches-via-cosma">Créer des fiches via Cosma</a></li></ul></li><li><a href="#creer-du-contenu-donnees-tabulaires-(csv)">Créer du contenu : données tabulaires (CSV)</a><ul><li><a href="#metadonnees-pour-les-noeuds">Métadonnées pour les nœuds</a></li><li><a href="#metadonnees-pour-les-liens">Métadonnées pour les liens</a></li></ul></li><li><a href="#creer-un-cosmoscope">Créer un cosmoscope</a><ul><li><a href="#generer-un-cosmoscope-dexemple">Générer un cosmoscope d'exemple</a></li><li><a href="#traiter-les-citations">Traiter les citations</a></li><li><a href="#appliquer-une-css-personnalisee">Appliquer une CSS personnalisée</a></li><li><a href="#utiliser-un-fichier-de-configuration-global">Utiliser un fichier de configuration global</a></li><li><a href="#exclure-certaines-fiches-du-cosmoscope">Exclure certaines fiches du cosmoscope</a></li><li><a href="#historique">Historique</a></li><li><a href="#rapport-derreurs">Rapport d'erreurs</a></li></ul></li><li><a href="#utilisation-du-cosmoscope">Utilisation du cosmoscope</a><ul><li><a href="#graphe">Graphe</a></li><li><a href="#fiches">Fiches</a></li><li><a href="#mode-focus">Mode focus</a></li><li><a href="#mode-chronologique">Mode chronologique</a></li><li><a href="#moteur-de-recherche">Moteur de recherche</a></li><li><a href="#filtrer-laffichage-par-types">Filtrer l'affichage par types</a></li><li><a href="#mots-cles">Mots-clés</a></li><li><a href="#index">Index</a></li><li><a href="#vues">Vues</a></li></ul></li><li><a href="#partage-et-publication-dun-cosmoscope">Partage et publication d'un cosmoscope</a></li><li><a href="#credits">Crédits</a><ul><li><a href="#equipe">Équipe</a></li><li><a href="#bibliotheques-utilisees">Bibliothèques utilisées</a></li></ul></li><li><a href="#changelog">Changelog</a><ul><li><a href="#v200">v2.0.0</a></li></ul></li></ul>
</nav>
</aside>
<main>
<p><strong>Version :</strong> CLI v2.0.0</p>
<p><strong>Dernière mise à jour :</strong> 21 avril 2023</p>
<h2 id="installation-et-mise-a-jour" tabindex="-1">Installation et mise à jour</h2>
<h3 id="installation" tabindex="-1">Installation</h3>
<p>Cosma est disponible en deux versions : une application à interface graphique (<em>graphical user interface</em>, GUI) et une application exécutable en ligne de commande (<em>command line interface</em>, CLI). Les informations concernant la version GUI sont détaillées <a href="https://cosma.graphlab.fr/docs/manuel-utilisation/">sur une page dédiée</a>.</p>
<p>La version CLI de Cosma est disponible pour macOS, Windows et Linux.</p>
<p>L'installation de <a href="https://nodejs.org/">NodeJS</a> version 12 minimum est requise.</p>
<p>Le gestionnaire de paquets NPM est installé automatiquement avec NodeJS. NPM peut être utilisé pour gérer l'installation de Cosma CLI. Entrez la commande ci-dessous dans votre terminal pour installer Cosma CLI de manière globale. Le logiciel s'exécute alors en écrivant <code>cosma</code>.</p>
<pre><code>npm install @graphlab-fr/cosma -g
</code></pre>
<p>Si vous souhaitez installer Cosma CLI comme dépendance d'un projet NodeJS, utilisez la commande ci-dessous. Le logiciel s'exécute alors depuis la racine du projet en écrivant <code>./node_modules/.bin/cosma</code>.</p>
<pre><code>npm install @graphlab-fr/cosma
</code></pre>
<h3 id="mise-a-jour" tabindex="-1">Mise à jour</h3>
<p>La commande suivante affiche la liste des paquets installés via NPM pour lesquels une mise à jour existe :</p>
<pre><code>npm outdated
</code></pre>
<p>La commande suivante met à jour Cosma CLI si une mise à jour existe :</p>
<pre><code>npm update cosma
</code></pre>
<h2 id="presentation" tabindex="-1">Présentation</h2>
<p>Cosma CLI est la version ligne de commande (<em>command-line interface</em>, CLI) de Cosma, un logiciel qui permet de représenter des graphes documentaires sous forme de réseaux interactifs dans une interface web.</p>
<p>Cosma CLI fonctionne sur la base de fichiers de configuration écrits en YAML. Chaque fichier de configuration indique une source des données à utiliser, ainsi que différents paramètres qui régissent le comportement de Cosma pour cette source de données.</p>
<p>Deux approches peuvent être adoptées en fonction des besoins :</p>
<p>La première consiste à exécuter la commande <code>cosma</code> dans un répertoire où se trouve un fichier de configuration. On parle dans ce cas de fichier de configuration local. Les fichiers de configuration locaux doivent toujours être nommés <code>config.yml</code>.</p>
<p>L'autre approche consiste à exécuter la commande <code>cosma</code> en ajoutant l'option <code>--project <nom></code>, où <code><nom></code> correspond au nom d'un fichier de configuration présent dans un dossier spécial, le répertoire de données utilisateur. On parle dans ce cas de fichier de configuration global, ou <strong>projet</strong>. Celui-ci peut être nommé librement (ex : <code>toto.yml</code>). Cette seconde approche permet d'exécuter la commande <code>cosma</code> depuis n'importe quel emplacement.</p>
<div class="astuce">
<p>La méthode locale favorise l'automatisation et la reproductibilité dans un contexte de travail partagé ou distribué sur plusieurs machines. Elle permet en effet de transmettre simultanément données, configuration et instructions d'utilisation (commandes) sous une forme utilisable telle quelle, sans aucun paramétrage supplémentaire requis de la part du destinataire (humain ou machine).</p>
<p>À l'inverse, la méthode globale facilite l'utilisation prolongée du logiciel par un individu sur une seule machine.</p>
</div>
<h2 id="la-commande-cosma" tabindex="-1">La commande <code>cosma</code></h2>
<p>La commande <code>cosma</code> s'utilise de trois manières :</p>
<ol>
<li><code>cosma</code> affiche l'aide ;</li>
<li><code>cosma <option></code> exécute une option globale ;</li>
<li><code>cosma <commande> <options></code> exécute l'une des cinq commandes de Cosma (<code>config</code>, <code>record</code>, <code>autorecord</code>, <code>batch</code> et <code>modelize</code>), avec une ou plusieurs options facultatives.</li>
</ol>
<p>Les cinq commandes existent en version longue et en version courte (ex : <code>cosma config</code> ou <code>cosma c</code>). Certaines options disposent également d'une version courte (ex : <code>cosma config --global</code> ou <code>cosma config -g</code>). Dans les deux cas, version longue et version courte sont fonctionnellement identiques ; la version courte sert simplement à gagner du temps lors d'une utilisation répétée et prolongée.</p>
<p>Les sous-sections qui suivent détaillent les options globales.</p>
<h3 id="creer-le-repertoire-de-donnees-utilisateur" tabindex="-1">Créer le répertoire de données utilisateur</h3>
<pre><code>cosma --create-user-data-dir
</code></pre>
<p>Cette commande crée un répertoire de données utilisateur intitulé <code>cosma-cli</code> à un emplacement qui respecte la spécification <a href="https://xdgbasedirectoryspecification.com">XDG Base Directory</a>. L'emplacement exact dépend de chaque système d'exploitation et peut varier d'une version à l'autre d'un même système.</p>
<p>Si le répertoire de données utilisateur existe déjà, la commande affiche simplement son emplacement.</p>
<h3 id="afficher-les-projets" tabindex="-1">Afficher les projets</h3>
<pre><code>cosma --list-projects
</code></pre>
<p>Cette commande liste les fichiers de configuration présents dans le répertoire de données utilisateur, aussi appelés projets.</p>
<h3 id="afficher-le-numero-de-version" tabindex="-1">Afficher le numéro de version</h3>
<pre><code>cosma --version
cosma -V
</code></pre>
<h3 id="afficher-laide" tabindex="-1">Afficher l'aide</h3>
<p>Cosma dispose d'une aide générale :</p>
<pre><code>cosma --help
cosma -h
</code></pre>
<p>Une aide contextuelle est également disponible pour les cinq commandes de Cosma. Ajoutez l'option <code>-h/--help</code> à l'une de ces commandes pour afficher l'aide contextuelle.</p>
<p>Exemple :</p>
<pre><code>cosma config --help
</code></pre>
<h2 id="configuration" tabindex="-1">Configuration</h2>
<h3 id="creer-un-fichier-de-configuration" tabindex="-1">Créer un fichier de configuration</h3>
<pre><code>cosma config
cosma c
</code></pre>
<p>Cette commande crée un fichier <code>config.yml</code> dans le répertoire actuel.</p>
<h3 id="creer-un-fichier-de-configuration-global-(projet)" tabindex="-1">Créer un fichier de configuration global (projet)</h3>
<pre><code>cosma config --global <nom>
cosma c -g <nom>
</code></pre>
<p>L'option <code>-g/--global</code> suivie d'un nom crée un fichier <code>nom.yml</code> dans le répertoire de données utilisateur.</p>
<h3 id="creer-un-fichier-de-configuration-par-defaut" tabindex="-1">Créer un fichier de configuration par défaut</h3>
<pre><code>cosma config --global
cosma c -g
</code></pre>
<p>Lorsqu'elle n'est pas suivie d'un nom, l'option <code>-g/--global</code> crée un fichier <code>defaults.yml</code> dans le répertoire de données utilisateur. Ce fichier peut être ensuite modifié pour définir les valeur par défaut des différents paramètres de configuration de Cosma. Ces valeurs par défaut seront appliquées aux fichiers de configuration créés par la suite.</p>
<h3 id="parametres-de-configuration" tabindex="-1">Paramètres de configuration</h3>
<p>Vous trouverez ci-dessous la liste des paramètres utilisés par Cosma. Si un paramètre est absent d'un fichier de configuration, Cosma considère qu'il a sa valeur par défaut.</p>
<div class="important">
<p>Les types de fiches et de liens « undefined » sont requis pour le fonctionnement de l'application. Si vous les supprimez d'un fichier de configuration, Cosma les ré-insèrera automatiquement lors de la prochaine utilisation de ce fichier.</p>
</div>
<table>
<thead>
<tr>
<th>nom</th>
<th>description</th>
<th>valeurs possibles</th>
<th>valeur par défaut</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>select_origin</code></td>
<td>Type de la source de données</td>
<td><code>directory</code> (répertoire de fiches), <code>csv</code> (fichiers CSV locaux) ou <code>online</code> (fichiers CSV en ligne)</td>
<td><code>directory</code></td>
</tr>
<tr>
<td><code>files_origin</code></td>
<td>Emplacement des fiches pour <code>directory</code></td>
<td>chemin (répertoire)</td>
<td></td>
</tr>
<tr>
<td><code>nodes_origin</code></td>
<td>Emplacement des nœuds pour <code>csv</code></td>
<td>chemin (fichier CSV)</td>
<td></td>
</tr>
<tr>
<td><code>links_origin</code></td>
<td>Emplacement des liens pour <code>csv</code></td>
<td>chemin (fichier CSV)</td>
<td></td>
</tr>
<tr>
<td><code>nodes_online</code></td>
<td>Emplacement des nœuds pour <code>online</code></td>
<td>URL</td>
<td></td>
</tr>
<tr>
<td><code>links_online</code></td>
<td>Emplacement des liens pour <code>online</code></td>
<td>URL</td>
<td></td>
</tr>
<tr>
<td><code>images_origin</code></td>
<td>Emplacement des images utilisées dans le cosmoscope</td>
<td>chemin (répertoire)</td>
<td></td>
</tr>
<tr>
<td><code>export_target</code></td>
<td>Emplacement des exports</td>
<td>chemin (répertoire)</td>
<td></td>
</tr>
<tr>
<td><code>history</code></td>
<td>Copie de chaque cosmoscope généré via Cosma dans le répertoire <code>history</code></td>
<td><code>true</code> ou <code>false</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>focus_max</code></td>
<td>Distance maximale au nœud sélectionné en mode focus</td>
<td>nombre entier</td>
<td>2</td>
</tr>
<tr>
<td><code>record_types</code></td>
<td>Liste des types d'entités</td>
<td>liste</td>
<td></td>
</tr>
<tr>
<td>type d'entité</td>
<td></td>
<td>chaîne de caractères</td>
<td></td>
</tr>
<tr>
<td><code>fill</code></td>
<td>Couleur de remplissage du type de nœud</td>
<td>couleur HTML</td>
<td></td>
</tr>
<tr>
<td><code>stroke</code></td>
<td>Couleur du contour du type de nœud (utilisée lorsque le nœud est rempli par une image)</td>
<td>couleur HTML</td>
<td></td>
</tr>
<tr>
<td><code>link_types</code></td>
<td>Liste des types de liens</td>
<td>liste</td>
<td></td>
</tr>
<tr>
<td>type de lien</td>
<td></td>
<td>chaîne de caractères</td>
<td></td>
</tr>
<tr>
<td><code>stroke</code></td>
<td>Style de tracé du type de lien</td>
<td><code>simple</code> (trait plein), <code>dash</code> (tirets), <code>dash</code> (pointillés), <code>double</code> (deux traits parallèles)</td>
<td><code>simple</code></td>
</tr>
<tr>
<td><code>color</code></td>
<td>Couleur du type de lien</td>
<td>couleur HTML</td>
<td></td>
</tr>
<tr>
<td><code>record_filters</code></td>
<td>Liste de métadonnées filtres</td>
<td></td>
<td></td>
</tr>
<tr>
<td>métadonnée filtre</td>
<td>Les fiches incluant cette métadonnée seront exclues lors de la création d'un cosmoscope</td>
<td>type, mot-clé, métadonnée déclarée dans <code>record_metas</code></td>
<td></td>
</tr>
<tr>
<td><code>graph_background_color</code></td>
<td>Couleur de fond du graphe</td>
<td>couleur HTML</td>
<td></td>
</tr>
<tr>
<td><code>graph_highlight_color</code></td>
<td>Couleur de surbrillance</td>
<td>couleur HTML</td>
<td></td>
</tr>
<tr>
<td><code>graph_highlight_on_hover</code></td>
<td>Application de la surbrillance au survol et à la sélection des nœuds</td>
<td><code>true</code> ou <code>false</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>graph_text_size</code></td>
<td>Taille des étiquettes des nœuds</td>
<td>nombre entier compris entre 2 et 15</td>
<td>10</td>
</tr>
<tr>
<td><code>graph_arrows</code></td>
<td>Ajout de flèches directionnelles aux extrémités des liens</td>
<td><code>true</code> ou <code>false</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>node_size_method</code></td>
<td>Méthode de dimensionnement des nœuds</td>
<td><code>degree</code> (taille proportionnelle au degré) ou <code>unique</code> (taille fixe)</td>
<td><code>degree</code></td>
</tr>
<tr>
<td><code>node_size</code></td>
<td>Taille des nœuds (taille fixe)</td>
<td>nombre entier compris entre 2 et 20</td>
<td>10</td>
</tr>
<tr>
<td><code>node_size_max</code></td>
<td>Taille maximale des nœuds (taille proportionnelle)</td>
<td>nombre entier compris entre 2 et 20</td>
<td>20</td>
</tr>
<tr>
<td><code>node_size_min</code></td>
<td>Taille minimale des nœuds (taille proportionnelle)</td>
<td>nombre entier compris entre 2 et 20</td>
<td>2</td>
</tr>
<tr>
<td><code>attraction_force</code></td>
<td>Force d'attraction</td>
<td>nombre compris entre 50 et 600</td>
<td>200</td>
</tr>
<tr>
<td><code>attraction_distance_max</code></td>
<td>Distance maximum entre les nœuds</td>
<td>nombre compris entre 200 et 800</td>
<td>250</td>
</tr>
<tr>
<td><code>attraction_vertical</code></td>
<td>Force d'attraction vers l'axe vertical</td>
<td>nombre compris entre 0 (désactivé) et 1</td>
<td>0</td>
</tr>
<tr>
<td><code>attraction_horizontal</code></td>
<td>Force d'attraction vers l'axe horizontal</td>
<td>nombre compris entre 0 (désactivé) et 1</td>
<td>0</td>
</tr>
<tr>
<td><code>views</code></td>
<td>Liste des vues enregistrées (GUI)</td>
<td>liste</td>
<td></td>
</tr>
<tr>
<td><code>chronological_record_meta</code></td>
<td>Métadonnée utilisée pour le mode chronologique</td>
<td><code>created</code>, <code>last_edit</code>, <code>last_open</code>, <code>timestamp</code>, métadonnée déclarée dans <code>record_metas</code></td>
<td><code>created</code></td>
</tr>
<tr>
<td><code>record_metas</code></td>
<td>Liste de métadonnées (présentes dans la source de données) à inclure dans le cosmoscope</td>
<td>liste</td>
<td></td>
</tr>
<tr>
<td><code>title</code></td>
<td>Titre du cosmoscope</td>
<td>chaîne de caractères</td>
<td></td>
</tr>
<tr>
<td><code>author</code></td>
<td>Auteur du cosmoscope</td>
<td>chaîne de caractères</td>
<td></td>
</tr>
<tr>
<td><code>description</code></td>
<td>Decription du cosmoscope</td>
<td>chaîne de caractères</td>
<td></td>
</tr>
<tr>
<td><code>keywords</code></td>
<td>Liste de mots-clés du cosmoscope</td>
<td>liste</td>
<td></td>
</tr>
<tr>
<td>mot-clé</td>
<td></td>
<td>chaîne de caractères</td>
<td></td>
</tr>
<tr>
<td><code>link_symbol</code></td>
<td>Symbole à afficher en remplacement des identifiants comme texte des liens internes dans le cosmoscope</td>
<td>chaîne de caractères</td>
<td></td>
</tr>
<tr>
<td><code>csl</code></td>
<td>Style bibliographique</td>
<td>chemin (fichier XML)</td>
<td></td>
</tr>
<tr>
<td><code>bibliography</code></td>
<td>Données bibliographiques</td>
<td>chemin (fichier JSON)</td>
<td></td>
</tr>
<tr>
<td><code>csl_locale</code></td>
<td>Localisation bibliographique</td>
<td>chemin (fichier XML)</td>
<td></td>
</tr>
<tr>
<td><code>css_custom</code></td>
<td>Feuille de styles CSS pour la personnalisation du cosmoscope</td>
<td>chemin (fichier CSS)</td>
<td></td>
</tr>
<tr>
<td><code>devtools</code></td>
<td>Affichage des outils de développement (GUI)</td>
<td><code>true</code> ou <code>false</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>lang</code></td>
<td>Langue du cosmoscope</td>
<td><code>en</code> (anglais) ou <code>fr</code> (français)</td>
<td><code>en</code></td>
</tr>
</tbody>
</table>
<div class="astuce">
<p>La couleur de fond du graphe et la couleur de surbrillance sont modifiables directement via le fichier de configuration mais toutes les couleurs de l'interface peuvent être modifiées en utilisant une feuille de style CSS personnalisée.</p>
<p>Appliquer une force verticale/horizontale resserre le graphe et permet de ramener plus près du centre les nœuds isolés.</p>
</div>
<h3 id="modele-de-configuration" tabindex="-1">Modèle de configuration</h3>
<p>Voici le modèle utilisé par Cosma pour générer un fichier de configuration :</p>
<pre><code>select_origin: directory
files_origin: ''
nodes_origin: ''
links_origin: ''
nodes_online: ''
links_online: ''
images_origin: ''
export_target: ''
history: true
focus_max: 2
record_types:
undefined:
fill: '#858585'
stroke: '#858585'
link_types:
undefined:
stroke: simple
color: '#e1e1e1'
record_filters: []
graph_background_color: '#ffffff'
graph_highlight_color: '#ff6a6a'
graph_highlight_on_hover: true
graph_text_size: 10
graph_arrows: true
node_size_method: degree
node_size: 10
node_size_max: 20
node_size_min: 2
attraction_force: 200
attraction_distance_max: 250
attraction_vertical: 0
attraction_horizontal: 0
views: {}
chronological_record_meta: last_edit
record_metas: []
title: ''
author: ''
description: ''
keywords: []
link_symbol: ''
csl: ''
bibliography: ''
csl_locale: ''
css_custom: ''
devtools: false
lang: en
</code></pre>
<h2 id="creer-du-contenu-fichiers-texte-(markdown)" tabindex="-1">Créer du contenu : fichiers texte (Markdown)</h2>
<p>Lorsque la source de données est de type <code>directory</code> (répertoire de fichiers Markdown), les données doivent respecter les règles suivantes :</p>
<ul>
<li>contenu rédigé en Markdown, extension de fichier <code>.md</code> ;</li>
<li>métadonnées exprimées en YAML, dans un en-tête présent en début de fichier ;</li>
<li>liens internes exprimés avec une syntaxe de type wiki (doubles crochets <code>[[ ]]</code>) et basés sur des identifiants uniques.</li>
</ul>
<p>Les sous-sections qui suivent expliquent ces règles en détail.</p>
<div class="note">
<p>Cette combinaison de normes d'écriture correspond au croisement de plusieurs cultures textuelles : la documentation (enrichir et indexer le contenu avec des métadonnées) ; les wikis (interrelier des connaissances) ; les pratiques de type Zettelkasten (tradition des fiches érudites) ; l'écriture scientifique avec Pandoc (utiliser le format texte comme source pour plusieurs autres formats).</p>
<p>Cosma fonctionne donc particulièrement bien lorsqu'il est utilisé en tandem avec des environnements d'écriture qui adoptent également cette approche, comme <a href="https://zettlr.com">Zettlr</a> ou l'extension <a href="https://foambubble.github.io/foam/">Foam</a> pour Visual Studio Code et VSCodium.</p>
</div>
<h3 id="metadonnees" tabindex="-1">Métadonnées</h3>
<p>Pour être correctement interprétés par Cosma, les fichiers Markdown (<code>.md</code>) doivent respecter une certaine structure, et notamment la présence d'un en-tête en <a href="http://yaml.org">YAML</a> au début du fichier. Cet en-tête est créé automatiquement lorsque la fiche est créée via Cosma.</p>
<p>Exemple :</p>
<pre><code>---
title: Titre du document
id: 20201209111625
types:
- undefined
tags:
- mot-clé 1
- mot-clé 2
---
</code></pre>
<p>L'en-tête YAML est délimité par deux séries de trois tirets seuls sur une ligne (<code>---</code>). Un champ en YAML est composé d'un nom et d'une valeur séparés par un double-points.</p>
<p>Conformément à la spécification YAML, les listes peuvent être inscrite en mode <em>block</em> :</p>
<pre><code class="language-yaml">tags:
- mot-clé 1
- mot-clé 2
</code></pre>
<p>Ou bien en mode <em>flow</em> :</p>
<pre><code class="language-yaml">tags: [mot-clé 1, mot-clé 2]
</code></pre>
<div class="note">
<p><strong>Pourquoi un en-tête en YAML ?</strong></p>
<p>Certains logiciels identifient les métadonnées d'un fichier de manière heuristique. Par exemple, si la première ligne du fichier est un titre de niveau 1, alors celui-ci sera interprété comme le titre du fichier ; si la seconde ligne contient des mots préfixés par un croisillon <code>#</code>, alors ils seront interprétés comme des mots-clés.</p>
<p>L'inconvénient de ce fonctionnement est qu'il n'est pas interopérable : chaque logiciel a ses propres conventions, ce qui limite la capacité de l'utilisateur à changer d'outil.</p>
<p>Utiliser un en-tête en YAML permet de déclarer des métadonnées comme le titre et l'identifiant unique d'une fiche de manière explicite. Ceci présente l'avantage de rendre triviale la détection et la manipulation de ces métadonnées, aussi bien par une machine que par un humain. L'utilisation d'un format commun (comme YAML) augmente le nombre d'outils compatibles avec un même ensemble de fichiers. Et des outils informatiques très répandus comme les expressions régulières et les scripts <em>shell</em> permettent aux utilisateurs de convertir eux-mêmes leurs données de manière relativement simple si besoin.</p>
</div>
<h4 id="metadonnees-reconnues" tabindex="-1">Métadonnées reconnues</h4>
<p>Cosma reconnaît et utilise les champs suivants :</p>
<dl>
<dt><code>title</code></dt>
<dd>Obligatoire.</dd>
<dd>Titre de la fiche.</dd>
<dt><code>id</code></dt>
<dd>Obligatoire.</dd>
<dd>Identifiant unique de la fiche. Par défaut, Cosma génère des identifiants à 14 chiffres par horodatage (année, mois, jour, heures, minutes et secondes) sur le modèle de certains logiciels de prise de notes type Zettelkasten comme <a href="https://zettelkasten.de/the-archive/">The Archive</a> ou <a href="https://www.zettlr.com">Zettlr</a>.</dd>
<dt><code>type</code> ou <code>types</code></dt>
<dd>Types de la fiche. Facultatif. Une fiche peut avoir un ou plusieurs types. Si le champ n'est pas renseigné ou bien que ses valeurs ne correspondent pas à l'un des types renseignés dans la configuration, Cosma interprètera le type de la fiche comme non défini (<code>undefined</code>).</dd>
<dt><code>tags</code> (ou <code>keywords</code>)</dt>
<dd>Mots-clés de la fiche. Facultatif. La valeur doit être une liste. Il est possible d'utiliser <code>keywords</code> au lieu de <code>tags</code>, dans une logique de compatibilité avec Pandoc. Si une fiche comporte un champ <code>tags</code> et un champ <code>keywords</code>, seuls les mots-clés déclarés dans le champ <code>tags</code> sont interprétés par Cosma.</dd>
<dt><code>thumbnail</code></dt>
<dd>Facultatif.</dd>
<dd>Nom de fichier d'une image à utiliser comme vignette pour cette fiche dans le cosmoscope (à l'intérieur du nœud correspondant et en haut du panneau de droite lorsque la fiche est ouverte).</dd>
<dt><code>begin</code></dt>
<dd>Facultatif.</dd>
<dd>Métadonnée temporelle utilisée pour le mode chronologique.</dd>
<dt><code>end</code></dt>
<dd>Facultatif.</dd>
<dd>Métadonnée temporelle utilisée pour le mode chronologique.</dd>
</dl>
<h4 id="ajouter-dautres-metadonnees" tabindex="-1">Ajouter d'autres métadonnées</h4>
<p>Il est possible d'ajouter librement d'autres métadonnées dans l'en-tête YAML. Par défaut, Cosma ignore ces métadonnées au moment de créer un cosmoscope : elles ne sont pas incluses dans le rendu HTML des fiches. Pour que ces métadonnées soient prises en compte, inscrivez-les dans le fichier de configuration au niveau du champ <code>record_metas</code>.</p>
<p>Exemple :</p>
<pre><code>record_metas: [author, date, lang]
</code></pre>
<h3 id="contenu" tabindex="-1">Contenu</h3>
<p>Cosma interprète les fichiers comme étant rédigés en <a href="https://spec.commonmark.org/0.30/">CommonMark</a>, une version strictement définie du langage de balisage léger Markdown.</p>
<div class="astuce">
<p>Le <a href="https://www.arthurperret.fr/tutomd/">tutoriel CommonMark traduit en français</a> permet d'apprendre les bases de Markdown en 10 minutes.</p>
<p>Si vous souhaitez découvrir l'utilisation conjointe de Markdown et Pandoc, vous pouvez consulter le cours en ligne <a href="https://infolit.be/md/">Markdown et vous</a>.</p>
</div>
<p>Cosma génère un rendu des fichiers Markdown en HTML. Par conséquent, les fichiers Markdown peuvent également inclure du code HTML, ainsi que des images vectorielles en SVG. Cosma supporte également l'<a href="https://www.npmjs.com/package/markdown-it-attrs">ajout d'attributs via des accolades</a>, comme présenté ci-dessous.</p>
<pre><code class="language-markdown">Ce paragraphe sera en rouge{.red}
</code></pre>
<pre><code class="language-html"><div class="red">Ce paragraphe sera en rouge</div>
</code></pre>
<p>Les images au format JPG ou PNG peuvent être incluses dans le cosmoscope via la syntaxe Markdown. Exemple :</p>
<pre><code class="language-markdown">
</code></pre>
<p>Pour réduire la taille du cosmoscope, privilégiez les images hébergées sur le Web et incluses via une URL. Exemple :</p>
<pre><code class="language-markdown">
</code></pre>
<h3 id="liens" tabindex="-1">Liens</h3>
<p>À l'intérieur des fiches, vous pouvez créer des liens avec l'identifiant de la fiche cible entre double crochets.</p>
<p>Exemple :</p>
<pre><code>Un lien vers [[20201209111625]] une fiche.
</code></pre>
<p>À partir de la v2, vous pouvez également inclure le texte du lien entre les crochets.</p>
<p>Exemple :</p>
<pre><code>Un lien vers [[20201209111625|une fiche]].
</code></pre>
<p>Cosma permet de définir des types de liens. Chaque type de lien est caractérisé par un nom, une couleur et un tracé. Pour qualifier un lien dans une fiche, préfixez l'identifiant par le nom d'un type de lien suivi d'un deux-points.</p>
<p>Exemple :</p>
<pre><code>Le concept B dérive du [[générique:20201209111625]] concept A.
La personne D a écrit contre [[opposant:20201209111625]] la personne C.
</code></pre>
<div class="astuce">
<p>Si vous n'utilisez pas la syntaxe alternative, vous pouvez tout de même améliorer la lisibilité des fiches dans le cosmoscope en utilisant le paramètre <code>link_symbol</code>. Celui-ci accepte comme valeur une chaîne de caractères Unicode arbitraire, qui remplacera les identifiants entre les crochets dans le rendu HTML des fiches. Ceci permet d'alléger visuellement le texte des fiches en remplaçant les longs identifiants numériques par une convention personnelle. Cela peut être par exemple un symbole comme une manicule ☞, une flèche →, une étoile ⟡, etc.</p>
</div>
<h3 id="identifiants-uniques" tabindex="-1">Identifiants uniques</h3>
<p>Pour être correctement interprétée par Cosma, chaque fiche doit avoir un identifiant unique. Cet identifiant sert de cible aux liens internes.</p>
<p><strong>L'identifiant doit être une suite unique de caractères.</strong></p>
<p>Par défaut, Cosma génère des identifiants à 14 chiffres par horodatage (année, mois, jour, heures, minutes et secondes). Nous nous inspirons ici du fonctionnement de logiciels de prise de notes type Zettelkasten comme <a href="https://zettelkasten.de/the-archive/">The Archive</a> et <a href="https://www.zettlr.com">Zettlr</a>.</p>
<div class="note">
<p>De nombreux logiciels de prise de notes interreliées proposent d'établir les liens entre fichiers via leurs noms, et de gérer automatiquement la maintenance des liens lorsque les noms de fichiers sont modifiés. En choisissant plutôt d'utiliser des identifiants uniques, nous avons donné à Cosma un fonctionnement plus classique, plus strict, proche de celui du Web. Nous pensons qu'il s'agit de la manière la plus simple d'éviter les <a href="https://fr.wikipedia.org/wiki/Lien_mort">liens morts</a> de façon pérenne. Le fait de ne pas recourir à une maintenance automatique des liens notamment rend les données moins dépendantes d'une solution logicielle en particulier.</p>
</div>
<h3 id="creer-des-fiches-via-cosma" tabindex="-1">Créer des fiches via Cosma</h3>
<p>Cosma inclut plusieurs commandes qui permettent de créer rapidement des fiches en générant automatiquement leur en-tête.</p>
<div class="important">
<p>Ces commandes ne fonctionnent que pour une source de données de type <code>directory</code> (fichiers Markdown).</p>
<p>Ces commandes requièrent un fichier de configuration avec le paramètre <code>files_origin</code> correctement renseigné. Cela peut être soit un fichier <code>config.yml</code> présent dans le répertoire courant, soit un projet indiqué via l'option <code>-p/--project</code>.</p>
</div>
<h4 id="record-creer-une-fiche-(mode-formulaire)" tabindex="-1"><code>record</code> : créer une fiche (mode formulaire)</h4>
<pre><code>cosma record
cosma r
cosma record --project <nom>
</code></pre>
<p>Cette commande permet de créer une fiche à la manière d'un formulaire. Une fois la commande lancée, le logiciel demande successivement de saisir un titre, un ou plusieurs types, et un ou plusieurs mots clés. Seul le titre est obligatoire.</p>
<h4 id="autorecord-creer-une-fiche-(mode-one-liner)" tabindex="-1"><code>autorecord</code> : créer une fiche (mode <em>one-liner</em>)</h4>
<pre><code>cosma autorecord <titre> <types> <mots-clés>
cosma a <titre> <type> <mots-clés>
cosma autorecord <titre> <types> <mots-clés> --project <nom>
</code></pre>
<p>Cette commande permet de créer une fiche en une seule saisie. Seul le titre est obligatoire. Si vous saisissez plusieurs types ou plusieurs mots-clés, séparez-les par des virgules (les espaces suivant la virgule sont ignorés). Exemple : <code>type A, type B</code>, <code>mot-clé1, mot-clé2</code>.</p>
<h4 id="batch-creer-un-lot-de-fiches" tabindex="-1"><code>batch</code> : créer un lot de fiches</h4>
<pre><code>cosma batch <chemin>
cosma b <chemin>
cosma batch <chemin> --project <nom>
</code></pre>
<p>Cette commande permet de créer plusieurs fiches d'un coup. <code><chemin></code> correspond à l'emplacement d'un fichier au format JSON ou CSV décrivant les fiches à créer. Comme pour tous les autres modes de création de fiches, le titre (<code>title</code>) est obligatoire et les autres champs sont facultatifs.</p>
<p>Exemple de fichier JSON contenant deux fiches :</p>
<pre><code class="language-json">[
{
"title": "Titre de la fiche"
},
{
"title": "Paul Otlet",
"type" : ["Personne", "Histoire"],
"metas": {
"prenom" : "Paul",
"nom" : "Otlet"
},
"tags" : ["documentation"],
"begin" : "1868",
"end" : "1944",
"content" : "Lorem...",
"thumbnail" : "image.jpg",
"references" : ["otlet1934"]
}
]
</code></pre>
<p>Exemple de fichier CSV contenant ces mêmes fiches :</p>
<pre><code class="language-csv">title,content,type:nature,type:field,meta:prenom,meta:nom,tag:genre,time:begin,time:end,thumbnail,references
Titre de la fiche,,,,,,,,,,,
Paul Otlet,Lorem...,Personne,Histoire,Paul,Otlet,homme,1868,1944,image.png,otlet1934
</code></pre>
<div class="note">
<p><strong>Identifiants des fiches créées par lot</strong></p>
<p>Cosma génère des identifiants à 14 chiffres par horodatage : année, mois, jour, heures, minutes et secondes. Par conséquent, il est possible de créer manuellement une fiche par seconde, soit 86 400 fiches par jour. Ceci signifie qu'il existe une plage de 86 400 identifiants « réservés » à la création manuelle de fiches. Pour le 15 janvier 2022 par exemple, ces identifiants vont de 20220115000000 à 20220115235959.</p>
<p>Pour conserver ce fonctionnement sans risquer de générer des identifiants en double, le mode de création par lots génère des identifiants par pseudo-horodatage. Les 8 premiers chiffres, correspondant à la date (année, mois, jour), sont réels. Exemple : 20220115 (15 janvier 2022). En revanche, ceux correspondant aux heures, minutes et secondes sont générés en dehors des plages horaires réelles. Exemple : 256495. Comme il est impossible de créer une fiche manuellement à 25h 64min et 95s, il n'y a pas de risque de générer des identifiants en double en utilisant simultanément les deux méthodes.</p>
<p>Du fait de ce fonctionnement, il est possible de créer par lot jusqu'à 913 599 fiches par jour et par répertoire avant d'être à cours d'identifiants.</p>
</div>
<h2 id="creer-du-contenu-donnees-tabulaires-(csv)" tabindex="-1">Créer du contenu : données tabulaires (CSV)</h2>
<p>Cosma peut interpréter des données tabulaires contenues dans des fichiers CSV locaux ou en ligne. Il s'agit d'une alternative aux fichiers Markdown.</p>
<p>Les données tabulaires destinées à Cosma doivent être contenues dans deux fichiers : un pour les nœuds et un autre pour les liens. Les emplacement de ces fichiers doivent être renseignés dans le fichier de configuration.</p>
<div class="note">
<p>Vous pouvez générer des fichiers CSV via un tableur, et notamment depuis un tableur collaboratif en ligne. En fait, c'est parce que ce type d'outil existe que nous avons ajouté les fichiers CSV comme source de données alternative aux fichiers Markdown pour Cosma.</p>
<p>Nous vous proposons <a href="https://docs.google.com/spreadsheets/d/1Wxm3lxgSnHaqsIVQVyuMR4TmiJwjDSr-KJWaKqNjz_o/">un modèle de tableur Google Sheets</a> dont vous pouvez vous inspirer. Une feuille doit être consacrée aux nœuds et une autre aux liens. Cliquez sur Fichier › Partager › Publier sur le Web. Sélectionnez la feuille contenant les nœuds, puis changez le format « Page Web » en « Valeurs séparées par des virgules (.csv) ». Cliquez sur « Publier » puis copiez le lien de partage. Répétez l'opération pour la feuille contenant les liens (dans notre modèle, il s'agit de la feuille « Extraction » et pas « Liens »). Collez chaque lien dans le champ correspondant de la configuration du projet.</p>
</div>
<p>Les en-têtes de colonnes des fichiers CSV doivent respecter les règles suivantes.</p>
<h3 id="metadonnees-pour-les-noeuds" tabindex="-1">Métadonnées pour les nœuds</h3>
<p>Pour les nœuds, seule la métadonnée <code>title</code> (titre) est requise.</p>
<table>
<thead>
<tr>
<th>nom</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>title</code></td>
<td>Titre de la fiche (requis)</td>
</tr>
<tr>
<td><code>id</code></td>
<td>Identifiant unique</td>
</tr>
<tr>
<td><code>type:<nom></code></td>
<td>Typologie de fiches. Chaque typologie contient un ou plusieurs types. Ex : une colonne peut être appelée <code>type:primaire</code> et contenir des types comme <code>personne</code>, <code>œuvre</code>, <code>institution</code> ; une autre colonne peut être appelée <code>type:secondaire</code>, avec d'autres types.</td>
</tr>
<tr>
<td><code>tag:<nom></code></td>
<td>Liste de mots-clés</td>
</tr>
<tr>
<td><code>meta:<nom></code></td>
<td>Métadonnée définie par l'utilisateur</td>
</tr>
<tr>
<td><code>time:begin</code>, <code>time:end</code></td>
<td>Métadonnées utilisées par le mode chronologique</td>
</tr>
<tr>
<td><code>content</code></td>
<td>Contenu textuel de la fiche</td>
</tr>
<tr>
<td><code>thumbnail</code></td>