Question:
À quoi ressemble un manuel pendant que vous l'écrivez?
Michael Stachowsky
2019-09-25 17:24:04 UTC
view on stackexchange narkive permalink

J'avais l'idée d'écrire un manuel depuis plusieurs années maintenant. L'idée a pris plusieurs formes - un ensemble de notes de cours que je fournis sous forme de pdf, un texte qui est imprimé dans mon établissement, ou éventuellement un texte que je propose à un éditeur et (espérons-le) être accepté.

Cette question est pratique - lors de la rédaction d'un manuel, dans quel format est-il? Est-ce juste un gros fichier MSWord? Fichiers séparés? Existe-t-il un «éditeur de manuels» spécifique que les gens utilisent? Par exemple, dans les livres avec des sections séparées pour des exemples, des légendes, des définitions, etc., je ne peux pas imaginer faire ce genre de mise en page par moi-même. Je suppose que l'éditeur le comprend pour vous. Cependant, l'auteur doit indiquer "la case X va ici" n'est-ce pas? Comment cela fonctionne?

Modifier : pour plus de clarté, le texte sera utilisé dans un cours de communication professionnelle pour des disciplines techniques telles que l'ingénierie.

Vous trouverez ici l'évolution d'un vaste projet du mathématicien Ravi Vakil: http://math.stanford.edu/~vakil/216blog/index.html
Au moins dans les domaines scientifiques et techniques, il est beaucoup plus probable qu'il s'agisse d'un ensemble de fichiers LaTeX.La recherche de "modèle de livre LaTeX" renvoie environ 36 millions de visites.Certains éditeurs, comme O'Reilly, semblent avoir leurs propres modèles ...
"Y a-t-il un" éditeur de manuels "spécifique que les gens utilisent?"Cette question est, au fond, une question d'achat.De plus, c'est très large comme l'a mentionné David Ketcheson.
Très similaire à une thèse, si elle est écrite en LaTeX pour une discipline scientifique, même si peut-être avec un modèle de laouy plus sophistiqué, les premières versions sont utilisées / testées pour soutenir un cours
Six réponses:
Buffy
2019-09-25 18:28:38 UTC
view on stackexchange narkive permalink

Avant de consacrer beaucoup de temps à la mise en forme, contactez un ou deux éditeurs et voyez s'ils souhaitent collaborer avec vous et publier votre livre. S'ils sont assez excités, ils vous inscriront. Vous parlez normalement à un éditeur d'acquisitions à ce stade.

Mais chaque éditeur peut avoir différentes manières de travailler avec votre manuscrit et cela peut affecter votre façon de travailler et les outils que vous utilisez.

Pour le contenu du livre, travaillez avec les outils que vous préférez, mais à mesure que vous vous rapprochez de la publication, l'éditeur voudra ses propres formats.

Normalement, pour un manuel, on vous attribuera un éditeur (dans le sens de celui qui édite - un éditeur de contenu ). Ils feront des suggestions sur votre formulation et autres. Vous devrez travailler avec cette personne, en utilisant un ensemble d'outils mutuellement acceptables. Cela peut être Word ou autre chose. Si LaTex est requis, ils peuvent faire ce formatage eux-mêmes, et sinon, ils vous fourniront probablement un modèle requis à utiliser. Même s'ils préfèrent Word, ils auront probablement un modèle pour vous. Peut-être un modèle obligatoire .

Vous n'aurez qu'un contrôle limité sur le placement des figures et autres éléments similaires, et un contrôle limité sur la disposition. Mais l'éditeur préparera en quelque sorte le manuscrit pour l'impression en utilisant ses propres mises en page préférées: marges et autres. Ils peuvent même souhaiter que vous utilisiez ou évitiez certaines polices.

Je pense que très peu d'éditeurs n'imprimeront qu'une photocopie de votre manuscrit. Il y a un certain traitement avant la production. Alors, ne soyez pas obsédé par le formatage tant que vous ne travaillez pas avec un éditeur.

Certains éditeurs voudront des fichiers séparés pour tous les chiffres (ou même pour les chapitres). Images haute résolution. D'autres préfèrent créer eux-mêmes les fichiers image. Vous pouvez avoir besoin d'autorisations pour toutes les figures (ou photos) que vous ne créez pas vous-même. Si les autorisations doivent être payées, cela peut être votre responsabilité, ou l'éditeur peut vous donner un budget pour cela.

Une fois le manuscrit raisonnablement terminé, l'éditeur des acquisitions (ou un représentant) enverra probablement votre manuscrit pour examen à quelques personnes en qui il a confiance. Vous obtiendrez des suggestions d'amélioration du texte, peut-être beaucoup. Surtout pour un premier auteur. Votre livre pourrait être rejeté à ce stade, mais je pense que c'est très peu probable. Mais vous devrez répondre de manière appropriée à toutes les suggestions, généralement en modifiant le texte. Cette étape peut être exaspérante pour un auteur novice et il peut y avoir plusieurs cycles de révision.

Une fois qu'ils auront une version imprimable, ils vous enverront des épreuves pour votre approbation. Il peut s'agir simplement de fichiers pdf et vous pouvez généralement apporter des modifications mineures, mais beaucoup d'argent a été dépensé à ce stade, donc trop de changements seront problématiques. Mais votre travail antérieur avec l'éditeur de contenu devrait rendre cela discutable.

Ils essaieront de vous accommoder, mais vous devez également travailler avec eux.

Avez-vous publié un manuel vous-même?Une grande partie de ce que vous écrivez ne correspond pas à mon expérience à l'autre bout, par exemple, l'éditeur de contenu n'a pas besoin de Word ou de Latex car ils impriment généralement le manuscrit sur papier et font l'édition sur papier;l'éditeur peut changer les polices pendant la production assez facilement, et ainsi de suite.
@Allure, oui, plusieurs.Et avec plusieurs éditeurs universitaires.Les éditeurs de contenu avec lesquels j'ai travaillé travaillaient tous électroniquement.
Wolfgang Bangerth
2019-09-25 18:26:46 UTC
view on stackexchange narkive permalink

Je ne vais pas recommander un programme particulier à utiliser, mais plutôt suggérer des considérations:

  • Pour tout projet qui dépasse 20 pages, il n'est plus pratique de changer le formatage des choses à la main. En conséquence, vous voudrez utiliser un flux de travail qui (i) vous permet de définir des styles pour tout: en-têtes, marges, placement des figures, polices, etc. si vous changez d'avis plus tard sur la façon dont un en-tête de deuxième niveau doit être formaté, vous n'aurez à le changer qu'à un seul endroit, car il sera impossible de le faire de manière cohérente dans une centaine d'endroits différents si vous utilisez le balisage à la main . (ii) un flux de travail qui permet d'utiliser le même fichier de style pour chaque document distinct qui définit le livre; donc, si vous utilisez Word et choisissez d'avoir un fichier par chapitre, le style doit être défini dans un fichier de style externe qui peut être modifié séparément, plutôt que défini dans le fichier Word de chaque chapitre.

  • Facilitez les références croisées. Vous voudrez référencer des sections dans d'autres chapitres et d'autres figures de chapitre. Si vous gardez chaque chapitre dans un fichier séparé, cela va être difficile car vous ne pouvez plus référencer une balise - et écrire "voir Section 5.5" est sûr de devenir faux très rapidement si vous décidez d'ajouter une autre section avant cela. Il doit être "voir la section < référencer une balise>" où votre traitement de texte insère automatiquement le numéro de section qui correspond à la balise. C'est plus facile à faire si vous conservez tout dans le même document, ce qui garantit également que la numérotation de vos pages est toujours correcte. Je ne connais pas assez bien MS Word pour savoir si cela vous oblige à tout conserver dans un seul fichier; dans LaTeX, vous pouvez conserver chaque chapitre dans un seul fichier et n'avoir qu'un seul fichier maître qui "\ inclut" les chapitres individuels.

  • Dans votre choix de traitement de texte, anticipez ce que les éditeurs de votre région accepteront probablement. Je sais que vous pourriez écrire un livre en troff, mais il est peu probable que vous rendiez les éditeurs satisfaits de ce choix.

  • Anticipez de travailler avec d'autres sur le projet. Un livre est une grande entreprise - il peut y avoir des domaines dans lesquels vous souhaitez obtenir des commentaires des autres ou simplement aimer travailler avec un co-auteur. Choisissez un flux de travail qui vous permet de le faire. Une manière particulièrement mauvaise de collaborer, à mon avis, est d'envoyer des fichiers par e-mail. Vous êtes sûr de vous croiser à un moment donné, et une seule personne est autorisée à apporter des modifications au fichier à un moment donné - et il n'est pas toujours clair de qui il s'agit. Au lieu de cela, envisagez un flux de travail qui permet à plusieurs personnes d'apporter des modifications en même temps. Un exemple est google documents, mais vous pouvez également utiliser github avec des formats qui permettent de fusionner les modifications de plusieurs personnes dans le même fichier (en particulier, pour latex). Si vous configurez correctement Dropbox, cela peut également fonctionner: vous devez vous assurer que la personne qui a un fichier ouvert dans un traitement de texte verrouille le fichier afin que d'autres ne puissent pas le modifier en même temps.

Mon système personnel de choix est d'utiliser LaTeX, et soit de partager les fichiers avec mes collaborateurs via github (si le contrôle de version est utile) ou via au verso (si le contrôle de version n'est pas important). Mais je comprends que LaTeX n'est pas pour tout le monde. Pour les choses qui n'impliquent pas beaucoup de formules, j'ai également utilisé avec plaisir des documents google.

Il est également possible d'utiliser le contrôle de version avec Overleaf, car il permet désormais une synchronisation facile avec GitHub.
Erlend Magnus Viggen
2019-09-25 18:27:39 UTC
view on stackexchange narkive permalink

Bien que je sois sûr qu'il existe de nombreuses façons de le faire, la réponse courte est que si vous contactez un éditeur pour savoir s'il serait intéressé à publier un manuel basé sur votre texte, il vous dira comment il le ferait comme le texte à livrer. J'espère qu'ils vous diront d'utiliser Microsoft Word ou LaTeX.

J'ai personnellement l'expérience de l'écriture d'un manuel Springer sur la physique computationnelle avec cinq autres co-auteurs. Comme le livre est assez mathématique et que chaque auteur était à l'aise avec LaTeX, le choix d'utiliser le modèle LaTeX de Springer pour écrire notre livre était évident. Avec LaTeX, vous pouvez vous concentrer sur le contenu et le laisser gérer la mise en page pour vous (aidé par un peu de balisage de votre part). Au final, votre éditeur reprendra le texte et reformatera la mise en page selon ses standards. Néanmoins, le balisage que vous fournissez est très utile car il leur permettra de savoir comment vous voulez que le livre soit, surtout si vous avez utilisé un modèle de l'éditeur. Pour notre livre, la mise en page finale était presque identique à celle que nous avions lors de sa rédaction.

Vous voudrez également avoir un système de contrôle de version pour sauvegarder les anciennes versions de votre livre, et peut-être aussi pour collaborer avec d'autres auteurs. Nous avons utilisé git pour notre livre, même si je dois dire que ce n'est pas facile à apprendre pour les non-programmeurs. De nos jours, l'éditeur LaTeX en ligne Overleaf est un choix beaucoup plus simple et plus naturel, car il gère très facilement le contrôle de version et les auteurs multiples. Avec Word, je ne connais aucun système de contrôle de version à moitié décent à moins que vous n'ayez également accès à Sharepoint, vous risquez donc de devoir sauvegarder manuellement les anciennes versions.

Il existe une sorte de vcs intégré à Word lui-même, mais je n'ai aucune idée de son fonctionnement.
@TRiG: Je l'ai en fait utilisé moi-même et cela fonctionne bien, mais je pense qu'il nécessite un accès à OneDrive Entreprise ou Microsoft Sharepoint.Cependant, je me trompe peut-être.
Allure
2019-09-26 08:17:15 UTC
view on stackexchange narkive permalink

Réponse du point de vue de l'éditeur: en gros, vous pouvez écrire en utilisant l'éditeur de texte de votre choix. Vous pouvez même écrire manuellement le manuel et vous attendre à ce que l'éditeur le convertisse en format numérique (bien que, bien sûr, moins vous êtes un grand nom, moins l'éditeur est susceptible d'accepter le projet).

Cependant : il est évident que certains éditeurs de texte sont plus faciles à utiliser que d'autres, et différents éditeurs auront des styles préférés différents. Par conséquent, les éditeurs indiquent ce que l'on appelle un "fichier de style" préféré. En utilisant ce fichier de style, l'éditeur de texte & leur permet d'effectuer plus facilement la composition. Cela réduit les coûts et signifie qu'ils peuvent vous offrir un taux de redevance d'auteur plus élevé.

Quant au positionnement des figures, oui, vous pouvez indiquer où vous les voulez. Il est courant d'essayer de positionner les figures de telle sorte qu'elles se trouvent à moins de deux pages de l'endroit où elles sont mentionnées pour la première fois dans le texte (c'est en fait pourquoi il est assez courant de voir des requêtes d'auteur de la forme "cette figure n'est pas référencée dans le texte" - l'éditeur ne sait pas où le positionner). Cependant, vous n'avez pas à le positionner vous-même, et cela pourrait même ne pas être une bonne utilisation de votre temps, car le manuscrit final ne ressemblera probablement pas au manuscrit brut.

Ethan Bolker
2019-09-27 04:21:16 UTC
view on stackexchange narkive permalink

J'ai écrit plusieurs textes de mathématiques et un texte cs. Chacun a grandi à partir de notes de cours.

Je pense que le seul outil de formatage sensé pour un livre technique de nos jours est LaTeX. Je l'ai utilisé deux fois. Pendant que le livre était en construction, j'ai généré un PDF à distribuer aux étudiants. Dans chaque cas, j'ai fait la majeure partie de l'écriture avant d'avoir un éditeur. Quand j'en ai trouvé un, ils ont été ravis de prendre ma source LaTeX et de formater le livre avec leurs propres fichiers de classe et de style.

Séparer la forme de la fonction est l'une des principales forces de LaTeX. C'est possible mais désagréable dans MS Word. Si vous avez besoin d'équations, il n'y a rien de comparable à la belle typographie TeX.

Traitez cela comme un projet logiciel sérieux. Utilisez le contrôle de version. Écrivez beaucoup de petites macros qui encapsulent les constructions LaTeX, afin que vous ou l'éditeur puissiez changer l'apparence sans changer le contenu. Les gens de TeX & LaTeX Stack Exchange seront heureux de répondre à vos questions au fur et à mesure de votre mise à jour. Consultez la balise de workflow ici. Il existe des méthodes standard pour conserver chaque chapitre dans son propre fichier, créer une table des matières et un index, mettre les réponses aux exercices à la fin du livre, ...

Les équations de Word sont bien meilleures puisqu'elles ont réorganisé leur éditeur d'équations pour avoir une composition plus similaire à TeX dans Word 2007. À ce stade, la plupart des équations de l'éditeur d'équations intégré de Word [sont presque indiscernables] (http://www.gust.org.pl / projects / e-fonderie / tg-math / gust_e-foundry-math_fonts-presentation.pdf) à partir des équations LaTeX.Cependant, Word manque toujours de bases mathématiques, telles que la numérotation des équations sans solutions de contournement.
kcrisman
2019-09-26 06:44:10 UTC
view on stackexchange narkive permalink

Puisque vous ne semblez pas absolument avoir besoin de le publier avec un éditeur commercial ou universitaire pour tous vos objectifs, je vous recommande vivement de faire de votre livre une "ressource éducative ouverte". Que vous le fassiez ou non, je vous recommande toujours d'essayer le nouvel outil (ish) PreTeXt pour l'écrire.

L'un des défis de l'édition moderne est d'essayer de synchroniser le Web, l'impression , pdf, e-pub et / ou autres sorties. PreTeXt vous permet d'écrire un document XML (ou plutôt un ensemble de documents, généralement un par chapitre inclus dans un fichier maître) qui gère ensuite tous les types de sortie. Il commence à y avoir de plus en plus de styles HTML personnalisés, ainsi que des informations sur le style LaTeX.

Certains des textes mathématiques les plus connus qui l'utilisent sont Active Calculus et Judson's Algebra, et l'outil est certainement encore centré sur les mathématiques à certains égards, mais il est déjà très flexible, y compris le support de la poésie et une bonne quantité de notation musicale. Pour vos besoins, cela semble idéal, car vous pouvez utiliser le meilleur de l'affichage des ressources Web tout en ayant un accès complet à des diagrammes complexes et à une notation mathématique bien faite. Pour référence, voici la source d'un autre livre raisonnablement bien utilisé qui l'utilise.

L'une des meilleures parties (divulgation complète: j'ai moi-même utilisé cet outil pendant un certain temps et certains ateliers à ce sujet) est que les références croisées, l'entrée vidéo et bien d'autres choses TRÈS fastidieuses sont traitées plus ou moins automatiquement si vous les faites correctement du premier coup - pour l'impression et le html. Pour mon propre projet, je n'ai plus qu'à faire un seul caractère d'édition pour que le fichier LaTeX se compile parfaitement avec xelatex en utilisant quatre jeux de caractères différents, par exemple.


Peu importe l'outil que vous utilisez, je suggérez fortement ce qui suit:

  • Mettez chaque élément biblio au début. N'attendez pas plus tard; c'est horrible de le faire plus tard.
  • Faites des références croisées tôt et souvent, puis choisissez un outil qui prend en charge cette opération facilement et automatiquement.
  • Planifiez plusieurs formats de sortie. J'ai des étudiants qui utilisent des téléphones, des tablettes, des ordinateurs et des imprimés. Et cela dépend vraiment de l'institution et de la démographie particulière, donc si vous voulez qu'il soit utilisable dans de nombreux endroits, planifiez-le et utilisez un outil qui le prend en charge.

Vous savez maintenant quel outil Je pense que cela fonctionne, mais je pense que tout outil qui peut le faire est bien, et j'imagine que certaines combinaisons de produits MS et certains outils uniquement TeX peuvent le faire également.

Je ne recommande pas nécessairement d'utiliser Git ou un autre VCS immédiatement, bien que cela soit certainement utile de différentes manières et que je l'utilise.Une courbe d'apprentissage à la fois si vous êtes sûr que c'est uniquement pour votre propre usage pour le moment.
PreTeXt semble être encore plus pénible à taper que LaTeX (je veux dire, c'est un dérivé XML ...), et je serais très surpris si cela permet même le plus simple des macros et packages de LaTeX.Y a-t-il des astuces?Existe-t-il des éditeurs WYSIWYG?
Pas encore, mais vous pouvez chercher un peu dans les listes parce que les gens essaient de rendre certains des éditeurs (appropriés) plutôt sympathiques.Mais non, pas WYSIWYG - ce qui, à mon avis, est une TRÈS mauvaise idée pour écrire un livre dans tous les cas, car vous ne voulez pas vous soucier des flotteurs de chiffres pendant que vous écrivez!Si vous pouvez faire LaTeX, vous pouvez le faire - comme le dit mon expérience en atelier.
En ce qui concerne les macros ... vous seriez surpris, c'est assez flexible dans ce sens si vous voulez des choses uniquement LaTeX.Pour le Web, vous devrez peut-être conserver les éléments pris en charge par MathJax, mais c'est encore un peu.La liste sur pretext-support@googlegroups.com est assez réactive.
En ce qui concerne git: j'ai trouvé la partie individuelle du flux de travail git (commit, checkout et autres - en gros, en utilisant git comme outil de sauvegarde et d'historique) extrêmement facile à comprendre, mais c'est peut-être parce que je suis un combinatorialiste.J'ai l'impression que git devient moche lorsque vous arrivez à des commits de fusion compliqués (non automatiques), qui sont cependant facilement évités si vous avez 1 ou 2 contributeurs ou plus mais avec des zones d'action bien définies.
@darijgrinberg Compte tenu de vos intérêts, je ferai remarquer qu'il prend également en charge de très bons exemples de balisage de code ainsi que du code Sage, R et probablement même Macaulay en direct ... mais cela semblait un peu au-delà de ce que l'OP demandait.
Git peut en valoir la peine, et le flux est bon, mais de nos jours, même les «suites de productivité» permettent des choses comme les points de contrôle et les réviseurs, il ne serait donc pas strictement nécessaire de démarrer cette courbe d'apprentissage supplémentaire, même si ce n'est pas une mauvaise idée à obtenirhabitué.Par exemple, la différence entre les modifications par étapes et non par étapes prend un certain temps à s'habituer, même si vous êtes familier avec VC en général.
Je veux dire WYSIWYG pour les formules, les tableaux et autres environnements difficiles à manier - "WYSIWYG à petite échelle" si vous le souhaitez.(IIRC texmacs le fait pour LaTeX.) Je n'insisterais pas sur WYSIWYG pour la structure du document;ce n'est généralement pas une bonne chose.Mais si je dois éditer des formules à la main et que ces formules atteignent la taille que mes formules ont tendance à atteindre, je finis par prendre des heures ou par l'introduction de macros sérieuses.
Je demanderais sur la liste si vous êtes intéressé, mais je sais que les gens utilisent des macros avec.Je n'ai pas trop à moi.


Ce Q&R a été automatiquement traduit de la langue anglaise.Le contenu original est disponible sur stackexchange, que nous remercions pour la licence cc by-sa 4.0 sous laquelle il est distribué.
Loading...