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

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

En tant que personne habituée à LaTeX, faire cela dans Word est extrêmement douloureux. Cependant, je suis lié à Word pour cela. Les seules options que j'ai vues sont:

1. Écrivez ou copiez dans le document, puis utilisez une police de type fixe, organisez la mise en forme et espérez que Word n'a pas fait de majuscules pour vous. Inutile de dire que cela ressemble à de la merde.
2. Copiez et collez des captures d'écran du code source de l'EDI. Au moins je garde les couleurs. Cependant, si je change la taille de ma police, je suis foutu. Je suis également foutu au-delà des limites de la page. Et admettons-le, Word n'est pas excellent pour gérer plusieurs images sur un document.
3. Écrivez du HTML (pas vraiment une option ici)

Existe-t-il une meilleure façon (et idéalement portable) de le faire? Existe-t-il au moins une sorte de style verbatim similaire à l'environnement LaTeX? Y a-t-il au moins une jolie imprimante que je pourrais copier-coller en RTF?

Je déteste et méprise absolument travailler gratuitement pour Microsoft, étant donné qu'après tous ces milliards de dollars, ils n'ont TOUJOURS pas de bons guides sur des trucs comme celui-ci 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 zone de texte 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. Basculez vers NPP, choisissez le langage de coloration syntaxique de votre code, allez dans Plugins / NPPExport / Copier RTF dans le presse-papier
   
4. Revenez au mot et collez-le dans la zone de texte - il est peut-être trop petit ...
   
5. ... vous devrez peut-être changer 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à, 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, changez le libellé en Code et appuyez sur OK
   
9. Enfin, tapez votre légende dans la zone de légende nouvellement créée
   

Je suis récemment tombé sur ce post et j'ai trouvé des conseils utiles. Cependant, j'ai fini par utiliser une approche totalement différente qui correspondait à mes besoins. Je partage l'approche et mon raisonnement sur les raisons pour lesquelles j'ai choisi cette approche. Le message est plus long que je ne l'aurais souhaité, mais je pense que les captures d'écran sont toujours utiles. Espérons que la réponse serait utile à quelqu'un.

Mes exigences étaient les suivantes:

1. Ajoutez des extraits de code à un document Word, avec une coloration syntaxique pour une visibilité et une différenciation plus faciles du code et d'autres textes.
2. L'extrait de code doit être en ligne avec un autre texte.
3. L'extrait de code doit passer d'une page à l'autre sans effort supplémentaire.
4. L'extrait de code doit avoir une belle bordure.
5. L'extrait de code doit avoir la vérification orthographique désactivée.

Mon approche est la suivante:

1. Utilisez un outil externe pour atteindre 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 - http://www.planetb.ca/syntax-highlight-word . 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 lors de l'utilisation de Mozilla Firefox, comme l'ont également souligné quelques commentaires d'utilisateurs). Les étapes pour obtenir la coloration syntaxique sont répertoriées ci-dessous:
   • Ouvrez le site Web fourni ci-dessus dans Chrome et copiez l'extrait de code dans la zone de texte. J'utiliserai un exemple de XML pour démontrer cela (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 "Afficher les éléments en surbrillance". Cela ouvrira un nouvel onglet, avec un extrait de code mis en évidence par la syntaxe, dans ce cas l'exemple XML que nous avons choisi. Voir l'image ci-dessous par exemple.
   • Pour désactiver les numéros de ligne, inspectez la page dans Chrome. Ensuite, sous styles, désélectionnez la propriété "margin" dans ".dp-highlighter ol", comme indiqué dans l'image ci-dessous. Si vous souhaitez conserver les numéros de ligne, passez à l'étape suivante.
   • Sélectionnez le code en surbrillance de syntaxe et cliquez sur copier. Votre code est maintenant prêt à être collé dans Microsoft Word. Merci à ce blog pour avoir fourni 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 table dans Microsoft Word pour insérer l'extrait de code. Les étapes sont énumérées ci-dessous:

   • Insérez un tableau avec une seule colonne.
   • Collez le texte copié de l'étape 1. dans la colonne du tableau. J'ai conservé les numéros de ligne pour montrer à quel point cela fonctionne avec Microsoft Word.
   • Appliquez une bordure, comme vous le souhaitez. J'ai utilisé la taille 1pt. L'extrait de mot Microsoft résultant apparaîtra comme indiqué dans la capture d'écran ci-dessous. Notez à quel point il se brise sur la page - AUCUN effort supplémentaire n'est nécessaire pour gérer cela, ce que vous auriez à faire si vous insérez un objet "OpenDocument Text" ou si vous utilisez "Simple TextBox".

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

   • Sélectionnez le tableau entier ou le texte.
   • Accédez à l'onglet Révision. Sous Langue, choisissez "Langue de vérification". Un nouveau pop-up sera présenté.
   • Sélectionnez "Ne pas vérifier l'orthographe ou la grammaire". Cliquez ensuite sur OK.
   • La vérification orthographique du texte résultant est désactivée. Le résultat final est montré dans l'image ci-dessous et répond à toutes les exigences.

Veuillez indiquer si vous avez des commentaires ou des améliorations ou si vous rencontrez des problèmes avec l'approche.

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

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

Code source dans Xcode:

Copié et collé dans Word:

(Remarque: c'est une bonne idée de désactiver la vérification orthographique dans votre style "Code" dans Word.)

Cela dépend en quelque sorte de l'IDE. Visual Studio et Eclipse , par exemple, vous permettront de copier au format RTF et de le coller dans Word, en conservant toute votre mise en forme.

Notepad ++ a un plugin appelé "NppExport" (livré pré-installé) qui vous permet de copier en RTF, bien que je ne me soucie pas beaucoup de la coloration syntaxique de Notepad ++ (ce serait certainement passable cependant). Il prend en charge des dizaines de langues, tandis que les IDE susmentionnés sont limités à une poignée chacun (sans autres plug-ins).

Ceci est lié à cette réponse: https://stackoverflow.com/a/2653406/931265 La création d'un objet a résolu tous mes problèmes.

Insertion> Objet> Texte du document ouvert

Cela ouvrira une fenêtre de document, collera votre texte, le formatera comme vous le souhaitez et le fermera.

Le résultat est une figure. Cliquez avec le bouton droit sur l'objet et sélectionnez «ajouter une légende».

Vous pouvez maintenant faire des références croisées, créer une table de figures.

Sur un Mac, je trouve que cette solution avec vim est merveilleuse:

https://github.com/zerowidth/vim-copy-as-rtf

Vous pouvez utiliser Open Xml Sdk pour cela. Si vous avez le code en html avec la couleur et la mise en forme. Vous pouvez utiliser altchunks pour l'ajouter aux documents Word. Référez-vous à ce post Ajouter une chaîne HTML au document OpenXML (* .docx) J'espère que cela vous aidera!

C'est ce que j'ai fait.

Résultats finaux:

https://stackoverflow.com/a/25092977/1161594

Vous pouvez utiliser Plugin Syntax Highlight dans Ms.Word https://store.office.com/syntax-highlighter-WA104315019.aspx?assetid=WA104315019 . je suis cette étape et c'est du travail

Si vous recherchez toujours un moyen simple d'ajouter des extraits de code.

vous pouvez facilement aller dans [Insérer]> [Objet]> [Ouvrir le texte du document]> coller votre code> Enregistrer et fermer.

Vous pouvez également le mettre dans une macro et l'ajouter à votre barre d'accès facile.

Remarques:

• Cela ne prendra qu'une page de code.
• Votre code sera pas être autocorrected .
• Vous ne pouvez interagir avec lui qu'en double-cliquant dessus.

Dans Word, il est possible de coller du code qui utilise la couleur pour différencier les commentaires du code à l'aide de «Coller conserver la mise en forme source». Toutefois, si vous utilisez le code collé pour créer un nouveau style, Word supprime automatiquement le texte codé en couleur et le change en noir (ou quelle que soit la couleur par défaut automatique). Étant donné que l'application d'un style est le meilleur moyen de garantir la conformité aux exigences de format de document, Word n'est pas très utile pour documenter les programmes logiciels. Malheureusement, je ne me souviens pas qu'Open Office soit meilleur. La meilleure solution consiste à utiliser la zone de texte simple par défaut.

J'ai essayé toutes vos méthodes, mais elles n'ont pas fonctionné pour moi, en fait, j'ai créé une méthode plus simple en utilisant des tableaux MS Word .

Avantages:

1. Plus beau
2. Plus facile à gérer et plus cohérent
3. Sont moins sujets aux problèmes
4. Pas besoin de plugins externes ou de micro-codage MS Word.
5. Plus facile à manipuler par des utilisateurs simples ( comme moi ).

Inconvénients: Cela ne maintiendra pas la coloration du code bien que quelqu'un puisse améliorer mon astuce.

Pas:

1. Insérez un tableau 3x3, dans mon cas je fais toujours que la largeur totale du tableau soit égale à la largeur de la page libre ( 3 lignes minimum pour tester le style des tableaux ).

2. Utilisez des bordures invisibles ( option « Sans bordures » ) et activez l' option « Afficher le quadrillage ». il devrait avoir cet aspect. N'oubliez pas que ces lignes vous permettent de voir la grille du tableau et que le ne sera pas imprimé.

3. Ajustez l'espacement des cellules et la largeur des colonnes pour obtenir l'aspect que vous aimez. ( Vous devrez entrer dans " Propriétés de la table " pour un réglage fin ).

4. Créez un " Style de paragraphe " avec le nom de " Code " juste pour vos extraits de code ( vérifiez https://stackoverflow.com/a/25092977/8533804 pour avoir l'idée, vous n'êtes pas obligé de tout suivre)

5. Créez un autre " Style de paragraphe " avec le nom de " Code_numberline " qui sera basé sur le style créé précédemment.

6. Dans le nouveau " Code_numberline ", ajoutez le style de numérotation que vous aimez (cela automatisera la numérotation des lignes).

7. Appliquez " Code_numberline " à la première colonne et " Code " à la colonne 3.

8. Ajoutez un remplissage dans la colonne du milieu.

9. Enregistrez ce style de table et profitez-en!

Utilisez ceci - http://hilite.me/

hilite.me convertit vos extraits de code en un joli format HTML, facilement intégrable dans des articles de blog, des e-mails et des sites Web.

Comment: Copiez simplement le code source dans le volet de gauche, sélectionnez la langue et le jeu de couleurs, puis cliquez sur "Surligner!". Le HTML du volet de droite peut maintenant être collé sur votre blog ou votre courrier électronique, aucun fichier CSS ou Javascript externe n'est requis.

Pour un document Microsoft Word: copiez le contenu de la section Aperçu et collez-le dans votre document Microsoft Word.

3 sections: code source, HTML et aperçu

Il existe un moyen simple si vous souhaitez un formatage de code simple.

1. Ouvrez le mot> onglet Insérer> cliquez sur "Obtenir des compléments"
2. rechercher "Content mixer" 3. cliquer sur "Add"

Ensuite, l'ajout du mélangeur de contenu s'ouvrira automatiquement et vous pourrez copier-coller votre code là-dedans et cliquer sur "Insérer" pour l'insérer dans Word doc.

Ces réponses semblent obsolètes et assez fastidieuses par rapport à la solution de complément Web; qui est disponible pour les produits depuis Office 2013.

J'utilise Easy Code Formatter , qui vous permet de codifier le texte sur place. Il vous donne également des options de numérotation de ligne, de mise en évidence, différents styles et les styles sont open source ici: https://github.com/armhil/easy-code-formatter-styles afin que vous puissiez étendre le style vous-même. Pour installer - ouvrez Microsoft Word, allez dans l'onglet Insertion / cliquez sur "Obtenir des compléments" et recherchez "Easy Code Formatter"