home.md

@@ -9,10 +9,18 @@ L'objectif est de regrouper ici toutes les infos glanées en rédigeant des **re
 
 Difficulté : les fonctions évoluent ! ! 
 
-Le lecteur peut rechercher ce qui l'intéresse dans le texte. L'idéal serait qu'il puisse accéder au fichier markdown ; c'est le cas pour le readme, qui est téléchargeable. 
-   :warning:  vérifier si c'est le cas pour le wiki !!
+Pour qu'une doc soit facile à utiliser, il vaut mieux que la **structure** soit logique, que la **mise en forme** soit agréable et mette bien en évidence les concepts importants (gras, italique...). 
 
-Sinon, les fichiers markdown rédigés pour ce wiki seront ajoutés manuellement au repo, avec le risque d'un petit décalage entre le fichier et la dernière mise à jour...
+Comparons deux solutions : la doc en ligne (sous forme de wiki) et un PDF.
+L'avantage du **PDF** est qu'il est "stable" et **consultable hors ligne**. Les logiciels de traitement de texte permettent de construire une hiérarchie de titres formatés et de générer des tables des matières, de gérer la numérotation de tableaux et de figures et d'en générer les tables, d'insérer des notes de bas de page ou encore de gérer des liens hypertexte (notion de "signet") si on se donne la peine de les définir. Ils permettent également de travailler en mode "révision".
+L'avantage du **document en ligne**, de type wiki, est qu'il est facile à maintenir à jour, et à consulter sans téléchargement.
+Cette page contient des informations pour retrouver autant de fonctionnalités que possible d'un traitement de texte : mettre en forme, générer un sommaire et des liens hypertexte. 
+   :warning: numéroter les illustrations et générer une table n'est sans doute pas possible
+
+Les fichiers du **wiki** sont au format **markdown** spécifique à gitlab.
+On peut les modifier en ligne: gitlab fournit un éditeur simple et un éditeur plus avancé depuis 2021. Quand vous sauvegardez les modifications vous pouvez personnaliser un "commit message" : en effet, ce wiki est techniquement un dépôt (repository). Il est donc possible de **cloner ce dépôt**, de modifier les fichiers markdown en local puis de mettre à jour le wiki avec un git push.
+
+Une autre façon de mettre en ligne de la doc est d'utiliser le module **sphinx**, qui permet également d'extraire la description des classes si on a utilisé un format standard pour les décrire dans le code (docstring + description des paramètres)
 
 
 ## Structure de ces pages
@@ -291,8 +299,20 @@ Les Header ID sont générés automatiquement à partir de texte de titre:
 :bulb: plutôt que d'essayer de deviner les Header ID, cliquez sur les maillons de chaîne qui apparaissent à gauche (en mode lecture, pas édition) et **copiez le lien** pour le coller entre les parenthèses qui définissent l'yperlien
 
 ## Usage avancé
-sous Linux : le wiki est un repo clonable
-On peut donc cloner le **git**, récupérer les fichiers et les répertoires (dont celui qui contient les images insérées), et effectuer en local des modification avec le bon éditeur, puis **"committer"** et **"pusher"** les modifications sur le repo.
+Le wiki est un repo clonable.
+Gitlab vous propose une liste d'instructions qui n'est valable que sous Linux, mais on peut également cloner et pusher les modifs sous Windows :
+- cloner avec **git clode**
+- vérifier que l'on a récupéré les fichiers et les répertoires (dont celui qui contient les images insérées)
+- effectuer en local des modifications, si possible avec le "bon" éditeur, avec visualisation
+- puis **"commiter"** et **"pusher"** les modifications sur le repo.
+
+> C:\WorkSpace\2022-AtelierPython\wiki_atelier_python>git clone https://gitlab.irstea.fr/christine.poulard/Atelier_Inkscape.wiki.git
+> Cloning into 'Atelier_Inkscape.wiki'...
+>C:\WorkSpace\2022-AtelierPython\wiki_atelier_python>cd Atelier_Inkscape.wiki
+
+> C:\WorkSpace\2022-AtelierPython\wiki_atelier_python\Atelier_Inkscape.wiki>git pull origin main
+
+:warning: pas de « : » dans les noms de fichiers md, sinon le fichier ne peut pas être cloné
 
 ## Conversion Markdown => PDF ??
 Solutions non testées...