Climat Scolaire - Manuel utilisateur - Chapitre 2 : «Créer, Editer et suivi d un texte» Espace collaboratif Co-Ment Date : 01/12/2013 Référence du Projet : Chef de Projet : www.cndp.fr/climatscolaire Caroline Veltcheff / Bernard Kenklé Emplacement réseau : P:\Site national Climat scolaire et prévention des violences\manuel-espace Collaborati.docx Version : 1 Suivi de modification : -
Sommaire Projet... 3 Objet... 3 Création d un texte Co-ment... 3 Pré-requis : Constitution d'un groupe de travail... 3 Rédaction d'un texte... 3 Chargement d'un texte... 4 Choix du format de texte... 5 Format HTML... 5 Format Markdown (version Pandoc)... 5 Format RST... 5 Travail sur un texte Co-ment... 5 Présentation de la barre d'outils... 5 Annotation du texte... 6 Edition du texte... 6 Modifier un texte co-ment... 6 Créer une nouvelle version du texte... 9 Conserver/Détacher les commentaires de l'ancienne version... 9 Suivi des différentes versions d'un texte... 9 Consulter la liste des versions... 9 Comparer deux versions... 10 Revenir à une version antérieure... 10 Suivi de l'activité sur le texte... 10 S'abonner au flux public du texte... 10 S'abonner aux notifications du texte par mail... 10 EXPORT/IMPRESSION D'UN TEXTE CO-MENTÉ... 11 Impression... 11 Commentaires... 11 Format... 11 Rendu de la portée des commentaires... 11 Export... 11 Annexes : Rappels des éléments principaux de la syntaxe Markdown version Pandoc... 12 Climat Scolaire Manuel de l espace collaboratif Page 2 01/12/201313
Projet Objet Manuel Utilisateur Chapitre 2 : «Créer, Editer et suivi d un texte» destiné aux différents profils de l espace collaboratif pour le réseau académique. Création d un texte Co-ment Pré-requis : Constitution d'un groupe de travail Pour constituer un groupe de travail autour d'un texte co-ment, il faut que le gestionnaire (l administrateur ou référent pédagogique) ait sélectionné les utilisateurs qui auront accès au texte et attribuez-leur un rôle. Rédaction d'un texte Pour rédiger un texte, cliquez sur le lien «créer un texte» situé en haut de page ou dans la rubrique «Actions» de votre tableau de bord. Vous trouverez également ce lien en haut de la liste des textes de l'espace de travail (onglet «Textes»). Vous accédez alors au formulaire d'édition. Renseignez le titre de votre texte et son format. Vous pouvez ensuite rédiger votre texte dans la fenêtre prévue à cet effet. Agrandissez cette fenêtre en cliquant avec votre souris sur l'angle situé en bas à droite. Vous pouvez également créer un texte en procédant au copier-coller d'un fichier ou d'une page web. Si vous copiez-collez une page web, veillez à sélectionner le format html dans la liste déroulante. Vous pouvez associer des tags (mots-clés) à votre nouveau texte. Ces tags vous permettront par la suite, dans l'onglet «Textes», de filtrer les textes de votre espace de travail. Climat Scolaire Manuel de l espace collaboratif Page 3 01/12/201313
Chargement d'un texte Pour charger un texte sur votre plate-forme co-ment depuis votre poste de travail, 1. Cliquez dans un premier temps sur le lien «charger un texte» qui se trouve en haut de page, dans la rubrique «Actions» de votre tableau de bord et en haut de votre liste de textes (onglet «Textes»). 2. Renseignez ensuite le titre du texte à charger, son format, et les tags (mots-clés) à y associer. 3. Cliquez ensuite sur le bouton «Parcourir» et sélectionnez dans l'explorateur de fichiers le texte que vous souhaitez charger sur votre espace de travail. 4. Validez pour finir le chargement en cliquant sur le bouton «Enregistrer». Les formats de texte importables sur co-ment (et les formats de destination recommandés) sont les suivants : Texte (.txt) Html (.html) Microsoft word (.doc) Open document (.odt) Markdown (.mkd) Latex (.tex) Le format de destination markdown est recommandé. Si l'import au format de destination html ne fonctionne pas, choisissez le format markdown. Nous vous recommandons toutefois d'afficher vos fichiers.html dans votre navigateur et de créer un texte html en procédant à un copier-coller de la page web Le format de destination html est recommandé. Le format de destination html est recommandé. Le format de destination markdown est recommandé. Le format de destination markdown est recommandé. Attention, seule une partie de latex est supportée par le convertisseur utilisé. A noter que co-ment ne prend pas en charge les textes au format PDF. Climat Scolaire Manuel de l espace collaboratif Page 4 01/12/201313
Choix du format de texte Lorsque vous créez ou chargez un texte, co-ment vous donne à ce jour le choix entre 3 formats : HTML, Markdown (recommandé pour les textes entièrement rédigé sur co-ment) ou RST. Ce format sous-jacent apparaît lorsque vous éditez votre texte. C'est également sous ce format que votre texte est stocké dans la base de données. Lorsque vous souhaitez consulter et annoter un texte de votre espace de travail, et ce quel que soit le format choisi, votre texte est automatiquement converti en HTML. Format HTML Ce format est celui adopté par co-ment pour visualiser les textes de votre espace de travail. Vous pouvez opter également pour HTML comme format sous-jacent lors de la rédaction ou du chargement d'un texte sur la plateforme. Les outils proposés pour mettre en forme le texte sont proches de ceux d'un traitement de texte. Vous avez par ailleurs la possibilité d'écrire directement en HTML en cliquant sur le bouton «source» en haut à gauche de la barre d'outils. Format Markdown (version Pandoc) Les formats Markdown et RST sont tous deux des formats de wiki. Le format Markdown proposé par co-ment utilise la version Pandoc. Il s'agit du format par ailleurs utilisé pour les commentaires des textes co-ment sur la plate-forme. Dans le formulaire d'édition proposé lors de la création d'un texte co-ment, une barre d'outils est disponible pour aider à la mise en forme de votre texte (liste à puces, insertion d'url...). Pour explorer toutes les possibilités offertes par le langage Mardown (version Pandoc), nous vous recommandons de consulter la fiche mise à votre disposition en annexe de ce guide. Format RST Le format RST (Re-RtructuredText) est très proche du format Markdown. Il s'adresse aux utilisateurs souhaitant charger un texte en format RST et à ceux maîtrisant déjà ce langage. Travail sur un texte Co-ment Présentation de la barre d'outils Lorsque vous ouvrez un texte dans votre espace de travail, vous disposez en haut de page d'une barre d'outils qui vous donne accès aux informations et fonctionnalités suivantes : Climat Scolaire Manuel de l espace collaboratif Page 5 01/12/201313
Nombre de discussions (en haut à gauche de la barre d outils ). Parcours des discussions : l'utilisateur peut parcourir les discussions en cours sur le texte. Ce parcours s'opère par "emplacement" (dans l'ordre du texte) ou par "modification" (du commentaire le plus récent au plus ancien). Pour aller d'un commentaire à l'autre, utiliser les boutons et. : affiche tous les commentaires. : affiche les commentaires détachés (lorsque le passage commenté a été supprimé ou soumis à modification). : aligne les commentaires dans la marge à gauche pour faciliter la lecture du texte. : imprime le texte (avec ou sans les commentaires en fonction des options d'affichage sélectionnées au moment de l'impression). : exporte le texte commenté. Plusieurs formats possibles: PDF, html, sdt, epub, doc : abonne au flux public du texte. Le flux RSS permet à l'utilisateur de s'informer des dernières modifications apportées au texte. En dessous de la barre d'icône, un curseur vous permet de régler la largeur de la marge dans laquelle apparaissent les commentaires. Déroulez la barre d'outils pour avoir accès aux fonctionnalités avancées. Il suffit pour cela de cliquer sur la «poignée» représentée par le triangle fonctionnalités suivantes : sous la barre d'outils. Vous accédez alors aux onglets et aux «Filtrer les commentaires» : vous pouvez filtrer les commentaires du texte par état, auteur, date ou tag. L'outil de recherche permet de faire apparaître dans le texte les passages dont les commentaires contiennent le mot ou l'expression exacte renseignés. «Préférences» : le réglage des animations agit sur la vitesse d'apparition des commentaires et de déroulé des fils de discussion. «Préférences pour le texte» : choisissez un nouveau style dans la liste déroulante pour changer la classe de polices de votre texte. Annotation du texte Vous venez de créer votre texte co-ment. Vous pouvez maintenant procéder au travail d'annotation. Sélectionnez des passages du texte, commentez-les. Vous pouvez modifier la portée ou le contenu de vos commentaires à tout moment. A noter que seuls les gestionnaires, les éditeurs et les modérateurs peuvent modifier ou supprimer le commentaire d'autres utilisateurs. Pour plus d information se reporter au manuel - Chapitre 2 : «Gestion des commentaires de textes». Edition du texte Les gestionnaires et les éditeurs peuvent éditer un texte pour intégrer par exemple des propositions de modification reçues en commentaire. co-ment vous permet de créer ensuite une nouvelle version de votre texte avec la possibilité de conserver les commentaires affectés ou non par les modifications. Modifier un texte co-ment Pour modifier un texte, cliquez sur l'onglet «Editer». Vous accédez alors au formulaire d'édition du texte. Si vous pouvez modifier le titre et le corps du texte, vous ne pouvez en revanche en modifier le format qui reste celui défini lors de sa création. Le champ «note» vous permet de commenter brièvement les changements réalisés sur le texte. En éditant un texte un formulaire pré-saisi apparaît et relatif aux informations entré par l auteur au moment de la création de son texte. Climat Scolaire Manuel de l espace collaboratif Page 6 01/12/201313
Il contient un certains nombre de champs qui assureront de «pré-charter» le texte et qui sont les suivants : Titres (titre du texte) ; Châpo (description du texte) ; Format (par défaut markdown) ; Texte (contenu du texte de l auteur) ; Nouvelle version (facultative) (coché par défaut) ; Champ d'action (correspondant aux sept champs d action du climat scolaire). ATTENTION, vous ne pourrez en sélectionner qu un seul. Il pourra être enrichi par d autres axes au moment du processus de publication sur le site Web www.cndp.fr/climatscolaire; Thèmes, en fonction du choix du champ d action, une liste de thèmes associés sera proposée. Il sera pour vous possible d en sélectionner plusieurs en appuyant sur la touche Ctrl de votre clavier ; Tags pouvant correspondre aux mots clés que vous pourrez saisir ; Commentaire de validation (facultatif), informations pouvant par exemples être précisées au moment de la soumission du texte pour sa publications (souhait d associer d autres champs d action, plusieurs auteurs et organismes associé pour un seul texte, ) ; Conserver les commentaires (facultatif) (par défaut coché), il vous sert ici pour l export du texte ; Détacher les commentaires (facultatif) (coché par défaut) ; Ressources externes, vous pouvez attacher votre texte par des pièces jointes de type bureautique, média (image, son et vidéo) ou encore des liens externes. Ces éléments seront conservés sur le site Web au moment de sa publication. Un lien «Ajouter une autre ressource externe» vous permet comme son nom l indique d ajouter plusieurs pièces jointes à votre texte. Une fois avoir renseigné ces champs et cliqué sur le bouton «Enregistrer», une nouvelle version de votre texte a été effectué et un mail de notification sera envoyé aux personnes abonnées aux notifications de l'espace de travail et notamment aux gestionnaires et/ou référents académique susceptibles de proposer votre texte comme future ressources du site Web www.cndp.fr/climatscolaire. Climat Scolaire Manuel de l espace collaboratif Page 7 01/12/201313
Ces indications apparaîtront ensuite dans l'onglet «Versions» à côté de la nouvelle version du texte. Climat Scolaire Manuel de l espace collaboratif Page 8 01/12/201313
Créer une nouvelle version du texte Par défaut, co-ment crée une nouvelle version de votre texte. Cela vous permet à tout moment de consulter ou de revenir à une version précédente. Si vous ne souhaitez pas créer de nouvelle version de votre texte, décochez la case «Nouvelle version». Attention, aucun retour à l'ancienne version ne sera alors possible. Conserver/Détacher les commentaires de l'ancienne version Par défaut, co-ment conserve tous les commentaires publiés avant la création d'une nouvelle version du texte. Les commentaires associés à des passages du texte ayant subi des modifications sont alors détachées. Ils restent consultables par la suite. Vous pouvez toutefois choisir de : Ne conserver aucun des commentaires de la précédente version. Décochez pour cela les cases «conserver les commentaires» et «détacher les commentaires», Ne conserver que les commentaires associés à des passages qui n'ont pas été affectés par vos modifications. Décochez pour cela la case «détacher les commentaires», Ne conserver que les commentaires associés aux passages ayant subi des modifications. Décochez pour cela la case «conserver les commentaires». Suivi des différentes versions d'un texte co-ment vous permet de gérer le versionning de vos textes. Consultez les différentes versions d'un texte et comparez les versions deux à deux. A tout moment, vous pouvez revenir à une version antérieure de votre texte. Consulter la liste des versions Cliquer sur l'onglet «Versions» vous permet d'accéder à la liste des différentes versions du texte. Le nombre entre parenthèses dans l'onglet vous indique le nombre de versions existantes de ce texte. Dans l'onglet, retrouvez pour chaque version : son titre, son classement (la version #1 correspondant à la plus ancienne), les indications laissées par l'auteur de la nouvelle version, l'auteur de la nouvelle version, la date de création, le nombre de commentaires. En passant la souris sur le titre d'une version, vous accédez à plusieurs liens vous permettant : de voir la version en question, de la comparer à la version précédente, de revenir à cette version. Climat Scolaire Manuel de l espace collaboratif Page 9 01/12/201313
Comparer deux versions Sélectionnez les deux versions que vous souhaitez comparer en cliquant sur les boutons situés devant leur titre. Cliquez ensuite sur le bouton vert «Comparer les versions sélectionnées». Dans l'interface vers laquelle vous êtes dirigé, les deux versions apparaissent côte à côte. La version la plus ancienne est située à gauche de l'écran. Les modifications apportées d'une version à l'autre apparaissent en rouge dans le texte. Dans la version ancienne, il s'agit des éléments ayant été supprimés, et dans la plus récente des éléments ayant été rajoutés au texte. Les liens situés en haut des deux versions vous permettent de revenir à la liste des versions ou d'accéder directement à l'une ou l'autre des versions comparées. Revenir à une version antérieure Vous pouvez à tout moment revenir à une version antérieure de votre texte. Cliquez pour cela sur le lien «revenir à cette version» qui apparaît sous le titre de la version en question lorsque vous le survolez avec votre souris. co-ment crée alors une nouvelle version de votre texte sur la base de la version sélectionnée. Aucune version de votre texte n'est ainsi supprimée. Suivi de l'activité sur le texte Pour être alerté des contributions ou modifications apportées à un texte, vous disposez d un flux RSS et d une alerte par mail. S'abonner au flux public du texte Vous pouvez vous abonner au flux public du texte en vous rendant sur l'onglet «Suivi». Vous serez alors informé de toutes les dernières modifications apportées au texte et de tous les derniers commentaires publiés. Tous les utilisateurs ayant accès au texte, quel que soit leur rôle, ont également accès à ce flux. Le flux public est associé à une adresse internet (url): vous pouvez la transmettre à tous ceux que vous souhaitez tenir informés de l'activité sur le texte, même ceux ne disposant pas d'un accès à votre espace de travail co-ment. S'abonner aux notifications du texte par mail Vous pouvez recevoir par email les notifications du texte. Pour cela, cochez les cases prévues à cet effet dans l'onglet «Suivi». Ces notifications seront envoyées à l'adresse email indiquée lors de votre enregistrement sur l'espace de travail. Vous pouvez à tout moment modifier cette adresse en éditant votre profil. Climat Scolaire Manuel de l espace collaboratif Page 10 01/12/201313
EXPORT/IMPRESSION D'UN TEXTE CO-MENTÉ Impression Affichez le texte que vous souhaitez imprimer puis cliquez sur l'icône situé à droite de la barre d outils. Plusieurs options sont alors possibles en matière de commentaires, de format et de rendu de la portée des commentaires. Commentaires Choisissez dans la première liste déroulante les commentaires qui apparaîtront à l'impression. Vous pouvez choisir d'imprimer votre texte : avec l'ensemble des commentaires des utilisateurs ; sans aucun commentaire ; avec les commentaires que vous avez préalablement filtrés. A noter que si un commentaire filtré s'inscrit dans un fil de discussion, l'ensemble du fil de discussion apparaîtra à l'impression. Les commentaires apparaîtront en bas de page. Retrouvez les passages auxquels ils sont rattachés grâce aux numéros qui leur sont associés. Format Choisissez dans la deuxième liste déroulante le format à partir duquel imprimer votre texte. Vous pouvez choisir d'imprimer votre texte : en format PDF depuis votre navigateur Rendu de la portée des commentaires Vous pouvez enfin choisir dans la troisième liste déroulante la manière dont les passages annotés apparaîtront une fois votre texte imprimé. Pour délimiter les passages annotés, vous pouvez choisir d'utiliser : des marqueurs (se présentant sous la forme [n du commentaire>passage annoté<n du commentaire]) ; des marqueurs et la couleur de fond (sur lignage). Export La mise en forme simplifiée des textes dans co-ment permet un export de qualité. Pour exporter votre texte, cliquez sur l'icône situé à droite de la barre d outils. Climat Scolaire Manuel de l espace collaboratif Page 11 01/12/201313
Plusieurs options sont proposées en matière de commentaires, de format et de rendu de la portée des commentaires. Pour les commentaires et le rendu de la portée des commentaires, référez-vous à la section précédente. Les formats proposés lors de l'export d'un texte co-ment sont les suivants : Texte (.txt) Html (.html) Open document (.odt) Microsoft word (.doc) Microsoft word 2007 (.docx) Format PDF Markdown (.mkd) Latex (.tex) XML (.xml) Le format de destination markdown est recommandé. Format recommandé si vous souhaitez poursuivre le travail éditorial sur une page web. Format recommandé si vous souhaitez poursuivre le travail éditorial sur un traitement de texte. Format recommandé pour une impression de qualité. Format utile pour une insertion dans un site web supportant ce format. Format intéressant pour l'édition, en particulier scientifique. Format recommandé si vous souhaitez pouvoir ré-importer votre texte avec tous ses commentaires sur une autre instance co-ment. Annexes : Rappels des éléments principaux de la syntaxe Markdown version Pandoc Retrouvez ci-dessous les principaux éléments de syntaxe du langage Markdown version Pandoc utilisé par co-ment pour les commentaires et pour les textes (si l'utilisateur a choisi Markdown comme format sousjacent lors de la création du texte). Pour plus d'informations sur la version Pandoc de Markdown et les possibilités que vous offre cette syntaxe, nous vous invitons à consulter le guide d'utilisateur de Pandoc : http://johnmacfarlane.net/pandoc/readme.html Emphase - Pour mettre du texte en italique : *italique* ou _italique_ - Pour mettre du texte en gras : **gras** ou gras Code - Pour mettre du code dans le texte : Début du texte `code` fin du texte - Pour un paragraphe de code, mettre quatre espaces devant: Première ligne de code Deuxième ligne Citations Comme dans les courriels, il est possible de faire des citations : > Ce texte apparaîtra dans un élément HTML <blockquote>. Paragraphe - Pour faire un nouveau paragraphe, sauter une ligne : Premier paragraphe Deuxième paragraphe - Pour faire un simple retour à la ligne, mettre deux espaces en fin de ligne. Séparateur horizontal Pour créer un séparateur horizontal, trois tirets ou astérisques minimum son nécessaires : * * * --- - - - Liste - Sauter une ligne avant le début de la liste. - liste non ordonnée : * Pommes * Poires * Sous élément avec au moins quatre espaces devant. - liste ordonnée : 1. mon premier Climat Scolaire Manuel de l espace collaboratif Page 12 01/12/201313
2. mon deuxième Titres # un titre de premier niveau #### un titre de quatrième niveau ou Titre de niveau 1 ===================== Titre de niveau 2 -------------------- Liens Pour afficher un lien : [texte du lien](url "titre (facultatif)") Images Pour afficher une image : Note de bas de page Pour créer une note de bas de page : ^[contenu de la note] Climat Scolaire Manuel de l espace collaboratif Page 13 01/12/201313