1.2 Conventions

PRT 20/03/2018 – 2

Plan

1. Mon langage

2. Plan habituel d’une fiche

3. Mise en forme du texte

Gras

Italique

Liens

Substitution

Chemins de fichier

4. Repères (icônes et symboles)

5. Aspect des pages internet

6. Ma présentation des touches du clavier et du texte à saisir

Présentation

La forme que j’adopte pour présenter mon texte est importante car elle est porteuse de sens. Vous apprécierez de pouvoir grâce à elle, vous repérer dans mon discours. Cette fiche explique pourquoi j’ai opté pour telle forme plutôt qu’une autre ; votre compréhension de ce pourquoi favorisera par ricochet, votre compréhension du comment.

1. Mon langage

Je parle, naturellement, à la première personne du singulier. Mes fiches, dans ce cadre, s’apparentent à un cours.

J’utilise aussi cette première personne dans les procédures que je vous propose d’exécuter. C’est ma manière de vous inviter à vous approprier ce qu’il y a à faire ; en vous le disant à vous-même ce sera comme si vous vous le répétiez.

Je m’adresse à vous, vous l’avez remarqué, à la deuxième personne du pluriel ; un pluriel de politesse, qui n’empêche pas le tutoiement dans les échanges personnels ou les forums si cela vous est plus simple.

Il m’arrive aussi de parler à la première personne du pluriel, pour vous associer à la démarche en cours. Il s’agit souvent d’une analyse de situation, d’une découverte, d’une progression que nous faisons ensemble.

2. Plan habituel d’une page

Fiche ou page ?

« C’est tout un » dirait La plaisante sagesse lyonnaise. Fiche évoque le contenu pratique ; page évoque l’affichage sur un site internet.

En tête de page :

Sous le titre de la fiche, j’indique la date de la fiche et sa version. Les versions précédentes éventuelles sont précisées en fin de page au paragraphe Historique.

Devant la date, je pose le code du site : PRT pour Pratique @, BPMI pour Bonnes pratiques micro-informatiques, LOW pour le traitement de texte LibreOffice, LOC pour le tableur LibreOffice, WP pour Concevoir et paramétrer un site WordPress., etc.

 

Quatre paragraphes peuvent être présents, si nécessaire :

Logiciel et version : si la fiche mentionne une procédure avec un logiciel particulier, celui-ci est indiqué dans ce paragraphe avec sa version. Cela permet à l’utilisateur de faire la part des choses quand il utilise lui-même ce logiciel avec une version différente. Plusieurs logiciels peuvent être indiqués.

Plan de la fiche : si le plan de la fiche est assez fourni, il est indiqué dans ce paragraphe ; les liens facilitent votre circulation dans la fiche.

Préalables : si, pour la bonne compréhension de la fiche, vous devez connaître d’autres fiches, je les indique dans ce paragraphe avec un lien direct. Dans ce cas, je ne m’attarde pas dans le corps de la fiche à préciser ces notions supposées acquises.

Petite précision qui a son importance : je considère que vous connaissez les fiches de ce site Pratique @ pour aborder les autres sites.

Présentation : Je précise dans ce paragraphe le positionnement de la fiche et son sujet. Si vous faites une recherche dans le site, ce paragraphe vous indique si la fiche présentée ici répond à votre attente sans avoir besoin de rentrer dans son détail.

Le texte proprement dit

est présenté en paragraphes successifs avec des titres sur plusieurs niveaux, chaque niveau étant repérable par une forme précise, identique dans tous mes sites techniques. Il est important, au début, que vous vous familiarisiez avec la présentation de chaque niveau : cela facilitera votre repérage dans la fiche.

En fin de fiche, après le texte proprement dit

Des informations complémentaires peuvent apparaître dans trois paragraphes, si nécessaire :

Prolongements : ce paragraphe donne la liste des fiches qui traitent un sujet en prolongement de celui de la fiche.

En fait, quand un développement dans la fiche ouvre sur un prolongement, je le note à l’endroit de ce développement. Dans ce paragraphe en fin de fiche, ce sont les prolongements par rapport au sujet général de la fiche qui sont indiqués.

Liens : ce paragraphe récapitule les fiches citées dans le texte proprement dit, avec un lien pour y accéder directement. Les fiches citées plusieurs fois ne sont présentes qu’une fois. Si vous souhaitez trouver le lien d’une fiche, que vous savez avoir été citée dans la fiche, c’est ici que vous le trouverez sans avoir à aller à la pêche dans toute la fiche.

Historique : ce paragraphe donne la chronologie des mises à jour de la fiche. Quand une ancienne fiche est conservée sur le site, elle est accessible avec un lien direct.

3. Mise en forme du texte

J’utilise quatre mises en forme, et dans des cas précis.

Gras

Je mets un mot ou une expression en gras dans un paragraphe pour indiquer un mot-clé, le sujet de ce paragraphe, que vous pouvez considérer comme un titre pour ce paragraphe.

Italique

Je mets en italique :

  • suivant l’usage dans le monde de l’édition : les titres de livres, d’articles, et plus généralement des œuvres d’art ou littéraires, les marques déposées, les mots étrangers, les néologismes (mots que j’invente) ; le titre des fiches est toujours donné en italique ;
  • les citations, y compris de ce qui apparaît à l’écran ;
  • par extension : les noms de dossiers ou de fichiers informatiques, les chemins de fichiers, les URL (adresses internet) ;
  • tout ce qui a une valeur en soi, particulière dans le contexte, évitant d’employer les guillemets, que je réserve aux citations, ou le soulignement, trop agressif.

Liens

Quand un texte porte un lien vers un site ou une autre fiche, il est repérable par une couleur de fond légèrement différente de celle du fond de page.

Au survol avec la souris, le lien devient souligné.

Quand un lien pointe sur un autre endroit de la même fiche, il est caractérisé par un indice (de 1 à 3). Sur la destination, une précédée de cet indice est un lien pour revenir au point de départ.

Substitution

La substitution est une expression que je présente en clair entre crochets, comme ceci : [ceci est une substitution]. Elle permet de résoudre un problème fréquent en informatique que l’algèbre résout simplement avec ses variables. Quand je dit : X=12, j’utilise deux notions : celle de variable (on pourrait dire contenant) et celle de valeur (on pourrait dire contenu). Le nom de la variable (X) est stable ; en revanche, sa valeur (ici, 12) change en fonction des hypothèses ou du contexte.

La substitution me permet d’indiquer de quelle variable je parle (X : ceci est une substitution). Elle laisse mon lecteur libre de donner une valeur à cette variable, valeur qui correspond à son propre contexte, à la réalité qui est la sienne. Généralement, pour que la signification de cette variable soit facilitée, je fais suivre la substitution d’un exemple concret que j’amène avec : « quelque chose qui ressemble à… ».

Chemins de fichier

J’indique tous les noms de dossiers ou fichier en italique. Et je recours, le plus souvent possible, à l’indication du chemin d’un fichier pour indiquer dans quel dossier ou sous-dossier il est situé. L’expression est concentrée, mais néanmoins très parlante, évitant des périphrases lourdes. Exemple, pour indique le dossier des Archives de 2017 : Documents/ 09_Archives/ 2017/. Repères :

  • Le nom d’un dossier es suivi de « / »;
  • le « / » est suivi d’une espace pour favoriser les coupures normales lors des passages à la ligne;
  • Le nom d’un fichier n’est pas suivi de « / » ; son extension est souvent omise.

4. Repères  (icônes et symboles)

J’utilise quelques icônes en les associant à des formes de paragraphes particulières :

Astuce

Le paragraphe signalé par une ampoule présente une astuce, une bonne idée, une précision à noter pour son utilité.

Attention

Le point d’exclamation dans un triangle (que le code de la route utilise pour signaler un danger) indique soit une précision qu’il est important de respecter, soit une interdiction dont le non-respect pourrait causer quelques soucis.

Prolongements

Cette icône indique des prolongements au sujet traité dans la ou les fiches indiquées. L’image présente deux rouages pour ne pas la confondre avec la roue dentée généralement admise comme symbole de Paramètres.

Code

Le passage annoncé par le symbole de l’ADN est du code : soit un extrait de fichier, soit une procédure dialoguée avec le système. La police est particulière, le texte non justifié, et le paragraphe encadré. La couleur du fond est différente.

Les procédures sont présentées ici : PRT 1.03 Les procédures.

Costumiers

Cette icône signale que le texte en regard s’adresse à des compétences supérieures aux compétences de base. Je les appelle costumiers car elles veulent faire du sur-mesure. (Précisions ici : 1.01 Présupposés.

 Renvois à l’intérieur de la page  ↑ ↓

Quand dans une page, je fais allusion à un développement, cette allusion porte le lien vers le développement. Dans le titre du développement, une flèche ↑ ou ↓ porte un lien vers l’allusion, permettant d’y revenir (Wikipedia et LibreOffice Writer utilise ce principe entre les appels de notes et les notes).

5. Aspect des pages

Sur les sites, j’utilise une charte de couleurs simplifiée, chaque site ayant sa propre couleur dominante. J’ai défini deux types de pages : Repère et Fiche :

Les Repères donnent des informations générales sur le site ; elles sont le plus souvent accessibles à partir du premier niveau du menu général. Elles se reconnaissent avec leur fond foncé, et les caractères en clair (comme un négatif de photo). Les sommaires d’une partie, la page signalant une anomalie, la page affichant les résultats des recherches sont sur ce modèle.

Les Fiches sont le contenu proprement pratique du site. Elles apparaissent sur fond clair avec des caractères foncés.

6. Comment je présente les touches du clavier et les textes à saisir

Parler des touches du clavier pose un problème analogue à celui des substitutions. Le problème se complique du fait que certaines touches du clavier affichent un caractère à l’écran, et d’autres pas. Parmi ces dernières, certaines vont permettre de faire des compositions de touches (chaque composition ayant un effet particulier), d’autres vont servir de commande, comme par exemple [Entrée] qui valide la saisie d’une zone ou fait passer à la ligne suivante dans un texte.

Les touches du clavier

Je représente les touches du clavier avec le caractère imprimé dessus entre accolades. Exemple : {A} (touches normales). Je présente les autres touches entre crochets. Exemple : [Entrée].

 

J’appelle touche normale une touche du clavier qui lorsqu’on la tape, affiche à l’écran le caractère imprimé dessus.

 

J’appelle touche de contrôle une touche qui met le texte en forme, comme par exemple [Entrée] pour piloter un saut à la ligne suivante.

 

J’appelle touche de direction ou touche directionnelle une touche qui déplace le point d’insertion dans une zone ou qui permet de circuler entre les fenêtres ou les onglets. Exemple : ►, ◄, ▲, ▼, [Début], [Fin], [page ▼], [Page ▲]

 

J’appelle touche de fonction, les touches, sur la rangée supérieure du clavier alphabétique, imprimées de [F1] à [F12]. Le résultat de ces touches est dépendant du programmeur.

 

J’appelle touche de composition, une touche qui n’a aucun effet en elle-même, mais qui en association avec une ou plusieurs autres, permet d’obtenir des caractères particuliers ou d’activer des fonctions système (raccourcis clavier). Il s’agit de :

  • [Maj] (aux extrémités gauche et droite de la première rangée de lettres – deuxième rangée en partant du bas du clavier ; généralement elles fonctionnent de façon identique) ;
  • [Ctrl] (aux extrémités gauche et droite de la première rangée de touches ; même remarque) ;
  • [Alt] (à gauche de la barre d’espace ; appelée aussi [Option] sur Mac)
  • [Alt Gr] (à droite) ;
    • contrairement aux précédentes, ces deux touches Alt ont chacune une fonction particulière ;
  • [Windows] à gauche de [Alt], appelée parfois [Power] ou [Pomme] sur Mac.

Les compositions de touches

Généralement, une composition commence par l’appui sur une ou plusieurs touches de composition, puis se poursuit, sans les lâcher, par l’appui d’une ou plusieurs touches successives, et enfin, parfois, nécessite pour manifester son effet d’être relâchée en fin de composition.

  • Pour indiquer qu’une touche de composition doit être tapée et rester enfoncée, j’écris par exemple : [Alt Gr+] ou [MAJ+ Ctrl+] ; le signe « + » indique qu’il ne faut pas relâcher la touche qui précède ce « + » ; il est entre les crochets, ce qui signifie qu’il n’a pas à être tapé ;
  • Pour indiquer qu’une touche de composition doit être relâchée, je termine la composition avec « — » avant le crochet fermant ; ce caractère « – » n’a pas, non plus, à être tapé ;
  • Dans tous les autres cas, quand je mentionne une touche, je signifie que la précédente doit être relâchée ; car, sauf pour les touches de composition, on n’obtient rien en tapant deux touches en même temps.

Deux exemples sous Windows avec un clavier français de France : et É.

  • Pour vous inviter à taper le € (symbole monétaire de l’euro), j’indique : [Alt Gr+ e] ; dès que la lettre e est tapée, est affiché ; il est donc inutile que j’indique « — » à la fin de la séquence ;
    • Notez que la frappe de la lettre « e » est simplement indiqué par « e ».
  • Pour vous inviter à taper le É (« é » majuscule), j’indique : [Alt+ 0201— ] ; et là, je mets le signe « — » à la fin car ce n’est que lorsque je relâche la touche [Alt] que le « É » apparaît. Essayez.

Vous noterez que dans le premier cas, il s’agit de [Alt Gr] (touche de droite) et dans le deuxième [Alt] (touche de gauche) ; ce sont deux touches différentes ; si vous les confondez, ça ne marchera pas !

La composition des lettres accentuées majuscules et d’autres (Ç, œ, Œ, etc.) est expliquée ici : BPMI 4.4 Dompter son clavier, les caractères bizarres.
Les raccourcis clavier sont des combinaisons de touches qui remplacent le choix d’un menu ou le clic d’un bouton. Ils existent au niveau du système et au niveau des applications. C’est expliqué ici : BPMI 4.21 Les raccourcis clavier.

Informations complémentaires

Prolongements

1.3 Les procédures : cette fiche apporte d’autres précisions de présentation dans le cadre particulier des procédures opératoires.

Historique

29/11/2016 : création.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *