Commit af3c8550 authored by Antoine Fauchié's avatar Antoine Fauchié
Browse files

edit: corrections mineures dans l'introduction #1

parent 2d4b6381
......@@ -10,12 +10,12 @@ En premier lieu, veuillez [vous créer un compte sur Framagit](https://framagit.
1. Un peu de théorie ([parcours/01_theorie](./parcours/01_theorie.md))
- Gestion de fichiers : arborescence, nomenclature et versionnage
- Formats de texte
- Chaines éditoriales
- Edition savante
- Chaînes éditoriales
- Édition savante
2. Exercice 1 - Stylo ([parcours/02_stylo](./parcours/02_stylo.md))
- présentation
- édition d'un article
- export d'un article
- Présentation
- Édition d'un article
- Export d'un article
3. Outils ([parcours/03_outils](./parcours/03_outils.md))
......
......@@ -3,7 +3,7 @@
**Objectifs de ce tutoriel:**
- créer et éditer des documents divers
- devenir autonome dans l'utilisation de chaines de publications alternatives
- devenir autonome dans l'utilisation de chaînes de publications alternatives
- comprendre les enjeux liés aux formats et aux outils
- savoir trouver l'information qu'il vous manque
......
......@@ -16,23 +16,24 @@ Dans la racine vous trouvez plusieurs "boîtes".
L'emplacement du Dossier correspond à ce qu'on appelle son "chemin" (_path_).
Par exemple, par rapport à l'image ci-dessus, le dossier "Vacances" aura le chemin `/Document Personnel/Images/Vacances (dans un système Unix)` et `C:/Dossier Personnel/Images/Vacances`
Par exemple, par rapport à l'image ci-dessus, le dossier "Vacances" aura le chemin `/Document Personnel/Images/Vacances` (dans un système Unix) et `C:/Dossier Personnel/Images/Vacances` (dans un système Windows).
Il est important que vous connaissiez la structure de l'arborescence de votre ordinateur car c'est ainsi qu'on accède aux fichiers.
### Nomenclature de fichier
_Quel nom donner à un fichier ?_ Une question pas si banale que ça. Il existe des règles qui sont fondamentales pour :
- classer un fichier,
- le retrouver facilement,
- partager ses fichiers avec d'autres personnes
- éviter des problèmes de comptabilité d'un système à un autre
- partager ses fichiers avec d'autres personnes,
- éviter des problèmes de comptabilité d'un système à un autre.
Quelques règles à appliquer :
1. **les noms de fichier ne doivent pas contenir des caractères spéciaux, des accents NI des espaces.** Ce types de caractères peuvent poser des problèmes car l’ordinateur ne les reconnais pas immédiatement, il doit les convertir et dans la conversion il y a souvent des erreurs. Le fichier `mémoire de maîtrise.doc` sera difficile à retrouver. On préférera `memoire_de_maitrise.doc`.
2. **les noms des fichiers doivent être significatifs.** Le fichier `chapitre1.md` ne précise pas de quel ouvrage il est le chapitre 1. On préférera `Espace-numerique_chapitre1.md`.
3. **faites attention aux extensions que vous utilisez.** Par principe, ne masquez pas les extensions de fichiers dans vos navigateurs de fichiers. L'extension est une information primordiale pour la machine et les utilisateurs. Elle renseigne sur le format du contenu du fichier et sur ce qu'on doit/peut faire avec ce fichier. Un fichier `.doc` ne contient pas les mêmes données qu'un fichier `.pdf` par exemple.
1. **Les noms de fichier ne doivent pas contenir des caractères spéciaux, des accents NI des espaces.** Ce types de caractères peuvent poser des problèmes car l’ordinateur ne les reconnais pas immédiatement, il doit les convertir et dans la conversion il y a souvent des erreurs. Le fichier `mémoire de maîtrise.doc` sera difficile à retrouver. On préférera `memoire_de_maitrise.doc` ou `memoire-de-maitrise.doc`.
2. **Les noms des fichiers doivent être significatifs.** Le fichier `chapitre1.md` ne précise pas de quel ouvrage il est le chapitre 1. On préférera `espace-numerique-chapitre-1.md`.
3. **Faites attention aux extensions que vous utilisez.** Par principe, ne masquez pas les extensions de fichiers dans vos navigateurs de fichiers. L'extension est une information primordiale pour la machine et les utilisateurs. Elle renseigne sur le format du contenu du fichier et sur ce qu'on doit/peut faire avec ce fichier. Un fichier `.doc` ne contient pas les mêmes données qu'un fichier `.pdf` par exemple.
Récapitulatif :
......@@ -41,13 +42,12 @@ Récapitulatif :
- extension
- nom parlant
- camelCase
- exemples : `2019-01-11notesEDN6102marcelloVitaliRosati.md`
- exemples : `2019-01-11-notes-EDN6102-marcello-Vitali-Rosati.md`
[pour aller plus loin](http://ptaff.ca/blogue/2008/06/29/les_3_rgles_dor_pour_nommer_un_fichier/).
[Pour aller plus loin](http://ptaff.ca/blogue/2008/06/29/les_3_rgles_dor_pour_nommer_un_fichier/).
### Versionnage
## Formats de document
Le format d'un document déclare les principes de structuration du document.
......@@ -57,40 +57,41 @@ On distinguera deux catégories de formats :
1. **Formats propriétaires** : doc, docx, pdf, indd, rtf, kindle, etc.
- appartiennent à des entités privés
- conditionnent les pratiques
- posent des problèmes de perennité
- posent des problèmes de pérennité
- exigences commerciales avant les exigences de recherche
- peuvent être ouverts (exemple du format pdf)
- peuvent être ouverts (exemple du format PDF)
2. **Formats libres** : txt, HTML, XML, TeX, OpenDocument, EPUB, Markdown, etc.
- appartiennent à la communauté, ce qui favorise la perennité
- sont standards, ce qui favorise la perennité
- sont rédéfinis par les pratiques
- sont standards, ce qui favorise la pérennité
- sont redéfinis par les pratiques
- exigences de recherche en premier !
## Chaînes éditoriales
À nouveau, on distingue :
- des chaines basées sur des formats propriétaires : de [Microsoft Word](https://fr.wikipedia.org/wiki/Microsoft_Word) à [Adobe InDesign](https://fr.wikipedia.org/wiki/Adobe_InDesign) par exemple.
- des chaines basées sur des formats libres et standards : [XML](https://fr.wikipedia.org/wiki/Extensible_Markup_Language), [TeX](https://fr.wikipedia.org/wiki/TeX), [Markdown](https://fr.wikipedia.org/wiki/Markdown), etc.
- des chaînes basées sur des formats propriétaires : de [Microsoft Word](https://fr.wikipedia.org/wiki/Microsoft_Word) à [Adobe InDesign](https://fr.wikipedia.org/wiki/Adobe_InDesign) par exemple.
- des chaînes basées sur des formats libres et standards : [XML](https://fr.wikipedia.org/wiki/Extensible_Markup_Language), [TeX](https://fr.wikipedia.org/wiki/TeX), [Markdown](https://fr.wikipedia.org/wiki/Markdown), etc.
[Markdown](https://daringfireball.net/projects/markdown) (`.md`) est un format de plus en plus utilisé comme format pivot dans les chaines de publication car il permet une édition structurée très simple capable de produire à peu près tous les formats.
[Markdown](https://daringfireball.net/projects/markdown) (`.md`) est un format de plus en plus utilisé comme format pivot dans les chaînes de publication car il permet une édition structurée très simple capable de produire à peu près tous les formats.
Remarque: ce cours est édité en Markdown (cliquez sur ![display source](./media/displaySource.png) pour voir la source).
Remarque : ce cours est édité en Markdown (cliquez sur ![display source](./media/displaySource.png) pour voir la source).
Getty, O'Reilly sont deux exemples de chaines de publication basées sur des formats de markup simple (respectivement Markdown et AsciiDoc). Pour en savoir plus, voir [le mémoire d'Antoine Fauchié](http://memoire.quaternum.net/).
[Quire](https://gettypubs.github.io/quire/) et O'Reilly sont deux exemples de chaînes de publication basées sur des formats de markup simple (respectivement Markdown et AsciiDoc). Pour en savoir plus, voir [le mémoire d'Antoine Fauchié](https://memoire.quaternum.net/).
Dans la prochaine partie, nous expérimenterons la chaîne _Stylo_, basée sur Markdown comme format pivot.
## Edition savante
Exigences particulières du secteur de l'édition savante.
Le secteur de l'édition savante a des exigences particulières.
L'enjeu principal est la structuration du document :
Enjeu principal de l'édition savante, c'est la structuration du document :
- choisir des formats qui permettent d'expliciter précisément la fonction de chaque élément du document (titre, citation, métadonnées, références bibliographiques, etc.)
- choisir des formats qui permettent d'expliciter précisément la fonction de chaque élément du document (titre, citation, métadonnées, références bibliographiques, etc.) ;
- avoir la possibilité de générer des formats de sortie (PDF imprimable, EPUB) à partir d'un fichier structuré.
Chaine markdown particulièrement adapté pour des contenus basés sur le texte.
Une chaîne Markdown est particulièrement adaptée pour des contenus basés sur le texte.
### Contenus et Métadonnées
......
......@@ -18,18 +18,17 @@
# Quelques outils indispensables
Pour la suite de l'atelier vous aurez besoin
d'installer les outils ci-dessous. L'utilisation de votre ordinateur personnel est recommandée.
Pour la suite de l'atelier vous aurez besoin d'installer les outils ci-dessous. L'utilisation de votre ordinateur personnel est recommandée.
## un éditeur de texte/code
## Un éditeur de texte/code
Les éditeurs de code sont plus ou moins simples selon les fonctionnalités qu'ils offrent. À minima pour l'atelier, l'éditeur devra pouvoir colorer la syntaxe Markdown, LaTeX, html et css (ce qu'ils font tous).
Les éditeurs de code sont plus ou moins simples selon les fonctionnalités qu'ils offrent. À minima, pour l'atelier, l'éditeur devra pouvoir colorer la syntaxe Markdown, LaTeX, HTML et CSS (ce qu'ils font tous).
Suggestion : [Atom.io](https://atom.io/) qui fonctionnera sur toutes les plateformes.
Voir d'autres éditeurs sous [Windows](https://alternativeto.net/software/atom/?platform=windows), [Max](https://alternativeto.net/software/atom/?platform=mac), [Linux](https://alternativeto.net/software/atom/?platform=linux).
Voir d'autres éditeurs sous [Windows](https://alternativeto.net/software/atom/?platform=windows), [Mac](https://alternativeto.net/software/atom/?platform=mac), [Linux](https://alternativeto.net/software/atom/?platform=linux).
## un convertisseur de format
## Un convertisseur de format
Un convertisseur de format permet comme son nom l'indique de convertir le format d'un document en un autre format. Le convertisseur génère alors un nouveau document.
......@@ -40,23 +39,24 @@ Nous utilisons [Pandoc](https://pandoc.org) en ligne de commande.
Nous aurons aussi besoin de l'extension **pandoc-citeproc** pour gérer les références bibliographiques.
## un compte sur framagit.org
## Un compte sur framagit.org
Sur [framagit.org](https://framagit.org/users/sign_in?redirect_to_referer=yes), créez vous un compte. Cela vous sera utile pour :
1. partager votre code avec moi (et la classe si vous le souhaitez),
2. publier des documents en ligne,
3. [participer au wiki](https://framagit.org/edn6102-h2019/edn6102/wikis/home) de ce répertoire.
3. [participer au wiki](https://framagit.org/marviro/tutorielmdpandoc/wikis/home) de ce répertoire.
Cliquez sur le bouton [Request Access] pour demander un accès au répertoire.
**Merci de m'envoyer ensuite votre username.**
## un gestionnaire de version : Git
## Un gestionnaire de version : Git
Le gestionnaire de version Git va vous permettre de communiquer votre code à framagit. Nous verrons ensemble comment l'utiliser.
- Linux: déjà installé
- Mac: déjà installé sinon, dans un terminal :
- Linux : déjà installé
- Mac : déjà installé sinon, dans un terminal :
- installer homebrew : `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
- installer Git avec homebrew : `brew install git`
- Windows : [installez Git pour Windows](https://git-scm.com/downloads)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment