gestion de documentations

Version imprimable

16/08/2017, 09h34
petitours

gestion de documentations
Bonjour

Je cherche à réaliser des documentations techniques sous latex avec ;
- des docs génériques ;
- des docs spécialisées sur des produits de différents niveaux (datasheet, manuels de référence...) :
- des docs type application note ou dossiers techniques sur des sujets particuliers liés indirectement au produits.
Pour cela je cherche à gérer mes docs comme un ensemble avec des entêtes et pieds de pages communs
des renvois entre documents et surtout de mon coté une tenue à jour cohérente de tout cela.
La topissitude serait atteinte en gérant une mise en ligne automatique des documents avec un système de vérification de version

Existe t-il des outils d'édition ou de gestion de tells choses ou faut il que je me le construise dans un quelconque langage de programmation ? (je fais du C# et de plus en plus de python pour abandonner le MS qui se cache derrière C#)

Je suis débutant avec Texlive et Texmaker mais je commence a bien m'y retrouver (et a beaucoup apprécier ! #WordNoMore)

Merci par avance pour vos réponses
16/08/2017, 21h52
-Nikopol-

Citation:

Pour cela je cherche à gérer mes docs comme un ensemble avec des entêtes et pieds de pages communs

Ça c'est facile.
Tu crées un fichier preambule.texcontenant ton préambule (avant le \begin{document}). Via la commande \input{preambule} tu intègres ce préambule dans tout tes documents. (Il y a d'autre méthode mais tu débutes). Et donc tu imagine bien que tous tes documents auront le même "style".

Citation:

des renvois entre documents et surtout de mon coté une tenue à jour cohérente de tout cela.

J'ai jamais eu besoin de gérer des liens entre plusieurs documents. Après une petite recherche, j'ai trouvé l'extension xr-hyper qui est maintenant pris en charge pas hyperref. Sur ce lien tu trouveras la documentation.

Citation:

Existe t-il des outils d'édition ou de gestion de telles choses ou faut il que je me le construise dans un quelconque langage de programmation ? (je fais du C# et de plus en plus de python pour abandonner le MS qui se cache derrière C#)

Il existe des éditeurs en ligne tel que overleaf qui permettent de travailler sur un fichier en ligne.
Sinon LaTeX embarque maintenant un langage de compilation : Lua via le moteur LuaTeX. Tu peux regarder ce document. Tu peux regarder aussi ces deux discussions code Lua 1 et code Lua 2
16/08/2017, 22h30
petitours

OK pour les inputs d’entête et pieds de pages définis dans un fichier externe, nickel il serait difficile d'imaginer plus simple

Pour les liens entre documents j'avais repéré xr mais pas vu que c’était géré dans hyperref que j'utilise déjà, je vais creuser, merci.

Pour luatex, j'ai un peu de mal à voir ce qu'on peut faire avec le code lua :koi:, je vais aussi creuser mais au pire, avec les input de fichiers externes il ne me resterait pas grand chose à coder ; juste une gestion documentaire avec date de mise à jour, un lancement automatique de la compilation (et j'imagine que lancer un compilateur PDF Latex depuis une application tierce ne doit pas être super compliqué) et ensuite mettre tout ça en ligne.
16/08/2017, 23h12
-Nikopol-

Citation:

OK pour les inputs d’entête et pieds de pages définis dans un fichier externe, nickel il serait difficile d'imaginer plus simple

oui tu peux aussi y mettre toutes tes macros comme \popluset toutes tes definitions.

Citation:

Pour les liens entre documents j'avais repéré xr mais pas vu que c’était géré dans hyperref que j'utilise déjà, je vais creuser, merci.

la réponse m'intéresse.

Citation:

juste une gestion documentaire avec date de mise à jour

\today

Citation:

et j'imagine que lancer un compilateur PDF Latex depuis une application tierce ne doit pas être super compliqué

La compilation se fait en ligne de commande, les éditeurs le font donc... c'est possible depuis un application tierce.

Citation:

et ensuite mettre tout ça en ligne

Il est possible de faire écrire à LaTeX dans un fichier externe (un .bat par par exemple). Je ne suis pas au point au niveau des scripts, mais si tu veux je te trouve un code pour écrire un .bat.
16/08/2017, 23h39
petitours

Citation:

Envoyé par -Nikopol-

oui tu peux aussi y mettre toutes tes macros comme \popluset toutes tes definitions.

c'était bien noté ça, j'ai commencé.

Citation:

Envoyé par -Nikopol-

la réponse m'intéresse.

La difficulté sera sans doute la tenue à jour de tous ces liens (trés vilain les liens morts...) je ne manquerai pas de faire un retour mais ce sera sans doute pas fait demain !

Citation:

Envoyé par -Nikopol-

\today

Je pensais à plus que la date du jour, mais à l'historique et tout le toutim légitime pour une doc de référence.
Ça ne semble pas possible sur un pdf (en tous cas je ne vois pas par quel mécanisme) mais le top aurait été que à l'ouverture du pdf, le pdf puisse aller voir sur internet si une mise à jour n'existe pas et en informer l'utilisateur ! 8O:ccool:

Citation:

Envoyé par -Nikopol-

Il est possible de faire écrire à LaTeX dans un fichier externe (un .bat par par exemple). Je ne suis pas au point au niveau des scripts, mais si tu veux je te trouve un code pour écrire un .bat.

Je ne percute pas sur l'usage que je pourrais faire d'un .bat :oops::traine::marteau:

Merci
16/08/2017, 23h50
Invité

Salut,

Pour les versions, regarder du côté d’un système de versionnage. Git peut être utilisé (avec ou sans Github).

Pour la compilation automatique, un petit script qui relance les commandes de compilation dès qu’une modification est détectée peut-être écrit. Je crois que latexmk le fait. En fait, ce script pourrait aussi se charger de la mise en ligne automatique (et pourrait être écrit en Python).
17/08/2017, 00h07
-Nikopol-

Citation:

Je pensais à plus que la date du jour, mais à l'historique et tout le toutim légitime pour une doc de référence.

ça c'est programmable.

Citation:

Envoyé par _Karnaj_

Salut,

Pour les versions, regarder du côté d’un système de versionnage. Git peut être utilisé (avec ou sans Github).

Pour la compilation automatique, un petit script qui relance les commandes de compilation dès qu’une modification est détectée peut-être écrit. Je crois que latexmk le fait. En fait, ce script pourrait aussi se charger de la mise en ligne automatique (et pourrait être écrit en Python).

oui vu ta demande...

Citation:

Je ne percute pas sur l'usage que je pourrais faire d'un .bat

faire un script pour mettre en ligne par exemple ou compiler le doc. C'est ce que tu souhaites non?
17/08/2017, 00h13
petitours

c'est quoi qui est paramétrable pour l'historique ?

et pour le .bat je débarque :oops:... on peut mettre dedans des chemins puis exécuter le ;bat et alors ça ferait des transferts sur un FTP par exemple ? (FTPS en TLS ou SFTP en plus il faudrait)

Vais me coucher moins idiot...
17/08/2017, 00h25
Invité

Le script peut être fait en BAT, en Python, en Ruby, etc. On trouve sûrement de quoi manipuler du FTP dans les bibliothèques de Python (vu que tu dis faire du Python). Une manière de voir le script serait de compiler un fichier et envoyer le PDF généré sur le serveur dès qu’il est modifié. Pour ne pas s’embêter à vérifier pour chaque fichier s’il a été modifié, on peut aussi lancer des compilations tous les jours (ou moins) et tout envoyer sur le serveur. Tout ça va dépendre des contraintes (nombre de fichiers, etc.).
17/08/2017, 00h29
petitours

Citation:

Envoyé par _Karnaj_

on peut aussi lancer ...

Qui peut ? Le script Latex dans lequel on ajoute du python ? il faut bien qu'il y ait un système qui reste actif pour pouvoir faire ces compilations (si nécessaire) périodiques. Une appli tierce codées en python de puis 0 je vois mais avec mon Texlive et Texmaker sous la main je suis largué là.

Merci
17/08/2017, 00h42
Invité

Citation:

Envoyé par petitours

Qui peut ? Le script Latex dans lequel on ajoute du python ? il faut bien qu'il y ait un système qui reste actif pour pouvoir faire ces compilations (si nécessaire) périodiques. Une appli tierce codées en python de puis 0 je vois mais avec mon Texlive et Texmaker sous la main je suis largué là.

Merci

Effectivement, moi je partais d’une compilation en ligne de commande. :roll: Ce n’est pas très différent, il faut juste utiliser la commande pdflatex pour avoir le PDF voulu (ou xelatex ou lualatex en fonction du moteur utilisé).

Ça va demander un peu de travail, mais ça ne paraît pas infaisable... Et ça m’intéresse pour un ensemble de fiches de maths (d’exercices et démonstrations classiques).

Bonjour,

Latexmk permet de compiler autant de fois que nécessaire si un changement est intervenu (jamais dépassé 3 fois personnellement). Il suffit de créer un fichier nommé latexmkrc dans le répertoire principal.
Code:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 # sortie de PDF uniquement $pdf_mode = "1"; # programme utilisé pour compiler $pdflatex = "xelatex -synctex=1 -interaction=nonstopmode %S"; # programme utilisé pour générer les index $makeindex = 'texindy -l -L french -C utf8 -M %B.xdy %B.idx'; # liste des extensions à nettoyer @generated_exts = ( 'aux' , 'bbl' , 'idx' , 'ind' , 'lof' , 'lot' , 'out' , 'toc' , 'gz' , '$fdb_ext' ); $clean_ext = "gls glg glo bak synctex.gz"; # définition du fichier par défaut à compiler @default_files = ('mon_fichier.tex');
J'utilise \usepackage[xindy]{imakeidx} % creation d'index pour les index et des commandes du type \makeindex[program=xindy, name=<nom de l'index>, title={Titre de l'index}]. Important les fichiers .xdy portent le nom de l'index de la commande précédente. Donc si je nomme mon index toto avec la commande name=toto mon fichier xdy s'appelle toto.xdy.

Pour le transfert sur mon FTP, j'utilise un simple script bash utilisant lftp et l'option mirror (je suis sous linux).
Code:

1 2 3 4 5 6 #!/bin/bash cd $HOME/<répertoire de base> # les 2 lignes qui suivent suppriment les fichiers de compilation avant de lancer le transfert #find . -name *.aux | xargs rm -rvf #$HOME/scripts/nettoyage_regle_latex.py lftp ftp.<mon_domaine> -e "mirror --verbose=3 -e -R -X *~ -X *.tks -X *.bak /home/winnt/<répertoire de base> /<répertoire à copier> ; quit"
Et merci pour l'extension xr que je ne connaissais pas. Elle devrait me rendre bien service.