Quelle est la meilleure façon d'insérer des exemples de code source dans un document Microsoft Word ?

Question

Je dois rédiger des documents qui incluront des exemples de code source. Certains des exemples seront écrits à partir de l'IDE, et d'autres seront écrits à la place. Mes exemples sont principalement en Java.

Pour quelqu'un qui est habitué à LaTeX, faire cela dans Word est extrêmement pénible. Cependant, je suis lié à Word pour cela. Les seules options que j'ai vues sont les suivantes :

1. Écrire ou copier dans le document, puis utiliser une police de caractères fixe, arranger formatage et espérer que Word n'a pas n'a pas mis de majuscules à votre place. Inutile de dire que de dire que cela ressemble à de la merde.
2. Copier et coller des captures d'écran de la source du code source de l'IDE. Au moins, je garde couleurs. Par contre, si je change la taille de ma taille de police, je suis foutu. Je suis également dans le pétrin d'une page à l'autre. Et admettons-le admettons-le, Word n'est pas très doué pour la gestion d'images multiples dans un document.
3. Écrire du HTML (ce n'est pas vraiment une option) ici)

Existe-t-il un meilleur moyen (et idéalement portable) de faire cela ? Existe-t-il au moins une sorte de style verbatim similaire à l'environnement LaTeX ? Existe-t-il au moins une jolie imprimante que je pourrais copier-coller en RTF ?

Answer 1

Je déteste absolument travailler gratuitement pour Microsoft, étant donné qu'après tous ces milliards de dollars, ils n'ont toujours pas de guides appropriés sur ce genre de choses avec des captures d'écran sur leur foutu site web.

Quoi qu'il en soit, voici un guide rapide dans Word 2010, utilisant Notepad++ pour la coloration de la syntaxe, et une TextBox qui peut être légendée :

1. Choisissez Insertion / Zone de texte / Zone de texte simple
   
2. Une zone de texte par défaut est insérée
   
3. Passez à NPP, choisissez la langue pour la coloration syntaxique de votre code, allez à Plugins / NPPExport / Copy RTF to clipboard
   
4. Revenez à word et collez dans la zone de texte - il se peut qu'elle soit trop petite ...
   
5. ... il se peut donc que vous deviez modifier sa taille
   
6. Après avoir sélectionné la zone de texte, cliquez dessus avec le bouton droit de la souris, puis choisissez Insérer une légende ...
   
7. Dans le menu Légende, si vous n'en avez pas déjà un, cliquez sur Nouvelle étiquette, et définissez la nouvelle étiquette sur "Code", cliquez sur OK ...
   
8. ... puis dans la boîte de dialogue Légende, changer l'étiquette en Code, et cliquer sur OK
   
9. Enfin, saisissez votre légende dans le champ de légende nouvellement créé
   

Answer 2

Je suis récemment tombé sur cet article et j'y ai trouvé quelques conseils utiles. Cependant, j'ai fini par utiliser une approche totalement différente qui répondait à mes besoins. Je vous fais part de cette approche et des raisons pour lesquelles je l'ai choisie. L'article est plus long que je ne l'aurais souhaité, mais je pense que les captures d'écran sont toujours utiles. J'espère que la réponse sera utile à quelqu'un.

Mes exigences étaient les suivantes :

1. Ajouter des extraits de code à un document Word, avec mise en évidence de la syntaxe pour faciliter la visibilité et la différenciation du code et du reste du texte.
2. L'extrait de code doit être en ligne avec le reste du texte.
3. L'extrait de code doit passer d'une page à l'autre sans effort supplémentaire.
4. L'extrait de code doit être entouré d'une jolie bordure.
5. Le correcteur orthographique doit être désactivé pour l'extrait de code.

Mon approche est la suivante :

1. Utiliser un outil externe pour répondre à l'exigence de coloration syntaxique 1 ci-dessus. On pourrait utiliser notepad plus plus comme décrit ci-dessus. Cependant, j'utilise l'outil présenté ici - https://syntax-highlighter.k26.ch/ . Cela me donne la possibilité d'utiliser le numéro de ligne, ainsi qu'une très belle coloration syntaxique (Veuillez utiliser Google Chrome pour cette étape, car la coloration syntaxique n'est pas copiée lorsque vous utilisez Mozilla Firefox, comme l'ont également souligné quelques commentaires d'utilisateurs). Les étapes pour obtenir la mise en évidence de la syntaxe sont listées ci-dessous :

• Ouvrez le site web fourni ci-dessus dans chrome et copiez l'extrait de code dans la zone de texte. Je vais utiliser un exemple de XML pour faire la démonstration (exemple de XML à partir d'ici). http://www.service-architecture.com/articles/object-oriented-databases/xml_file_for_complex_data.html ).

• Sélectionnez la langue dans le menu déroulant.

• Cliquez sur le bouton "Show Highlighted". Un nouvel onglet s'ouvrira, avec un extrait de code en surbrillance syntaxique, dans ce cas l'exemple XML que nous avons choisi. Voir l'image ci-dessous pour l'exemple.

• Pour désactiver les numéros de ligne, inspectez la page dans chrome. Ensuite, dans les styles, désélectionnez la propriété "margin" dans ".dp-highlighter ol", comme le montre l'image ci-dessous. Si vous souhaitez conserver les numéros de ligne, passez à l'étape suivante.

• Sélectionnez le code mis en évidence par la syntaxe et cliquez sur copier. Votre code est maintenant prêt à être collé dans Microsoft Word. Merci à ce blog de fournir ces informations - http://idratherbewriting.com/2013/04/04/adding-syntax-highlighting-to-code-examples-online-and-in-microsoft-word/ . 2. Pour répondre aux exigences 2, 3 et 4 ci-dessus, utilisez un tableau dans Microsoft Word pour insérer l'extrait de code. Les étapes sont énumérées ci-dessous :

• Insérer un tableau à colonne unique.

• Collez le texte copié à l'étape 1 dans la colonne du tableau. J'ai conservé les numéros de ligne pour montrer comment cela fonctionne avec Microsoft Word.

• Appliquez une bordure, comme vous le souhaitez. J'ai utilisé la taille 1pt. L'extrait Microsoft word résultant apparaîtra comme indiqué dans la capture d'écran ci-dessous. Notez qu'il se détache joliment de la page - AUCUN effort supplémentaire n'est nécessaire pour gérer cela, ce qui serait le cas si vous insériez un objet "OpenDocument Text" ou si vous utilisiez une "Simple TextBox".

  3. Pour satisfaire à l'exigence 5, suivez les étapes ci-dessous :

• Sélectionner l'ensemble du tableau ou du texte.

• Passez à l'onglet Révision. Sous Langue, choisissez "Langue d'épreuvage". Une nouvelle fenêtre contextuelle s'affiche.

• Sélectionnez "Ne pas vérifier l'orthographe ou la grammaire". Cliquez ensuite sur OK.

• Le correcteur orthographique est désactivé dans le texte résultant. Le résultat final est présenté dans l'image ci-dessous et répond à toutes les exigences.

N'hésitez pas à nous faire part de vos commentaires, des améliorations à apporter ou des problèmes rencontrés dans le cadre de cette approche.

Answer 3

Vous devez définir un style dans votre document Word et l'utiliser comme code source. J'ai généralement un style appelé "Code" qui utilise une police monospaciale de petite taille, des tabulations de taille fixe, un interligne simple, pas d'espacement entre les paragraphes avant et après, etc. Vous ne devez définir ce style qu'une seule fois et le réutiliser ensuite. Vous collez votre code source et lui appliquez le style "Code".

Notez que certains éditeurs (par exemple Xcode sur Mac) ajoutent RTF ainsi que du texte au presse-papiers lors du copier/coller entre applications - Word reconnaît RTF et conserve utilement le formatage, la coloration de la syntaxe, etc.

Code source dans Xcode :

Copié et collé dans Word :

(Remarque : il est conseillé de désactiver la vérification orthographique dans votre style "Code" dans Word).

Answer 4

Cela dépend de l'IDE. Visual Studio et Eclipse Par exemple, vous pouvez copier un fichier RTF et le coller dans Word, tout en conservant votre formatage.

Bloc-notes++ possède un plugin appelé "NppExport" (pré-installé) qui permet de copier au format RTF, bien que je n'aime pas beaucoup la coloration syntaxique de Notepad++ (qui serait cependant tout à fait passable). Ce qu'il fait, c'est qu'il supporte des dizaines de langues, alors que les IDEs mentionnés ci-dessus sont limités à une poignée chacun (sans autres plug-ins).

Answer 5

Utilisez ceci - http://hilite.me/

hilite.me convertit vos extraits de code en format HTML joliment imprimé, facilement intégrable dans les articles de blog, les courriels et les sites web.

Comment ? Il suffit de copier le code source dans le panneau de gauche, de sélectionner la langue et la palette de couleurs, puis de cliquer sur "Mettre en évidence". Le code HTML du volet de droite peut maintenant être collé sur votre blog ou dans votre courrier électronique, sans qu'aucun fichier CSS ou Javascript externe ne soit nécessaire.

Pour un document Microsoft Word : Copier le contenu de la page Avant-première et collez-la dans votre document Microsoft Word.

3 sections : Code source, HTML et Aperçu