LaTeX-ENSPS/README.md
2019-03-31 21:24:13 +02:00

2.9 KiB

Paquet LaTeX de l'École centrale de Lyon

Correctifs à apporter :

  • terminer le setup du siunitx, clarifier l'usage ;
  • faire un environnement pour les parties particulières du rapport (e.g. la page résumé) ;
  • faire une documentation ;
  • mettre en ordre le code par section (EN COURS).

Installation

Télécharger le dossier, le placer dans le sous-dossier de votre choix et modifier uniquement le fichier rapport.tex. Vous pouvez retirer le fichier README.md et le fichier de license.

Commandes utiles

Opérations basiques

  • Pour insérer une image : utiliser la commande fournie en exemple dans le rapport :
\begin{figure}[ht!]
    \centering
    \includegraphics[width=1\textwidth]{example-image-a}
    \caption{Insérer ici le sous-titre.}
    \label{fig:id-de-la-figure}
\end{figure}
  • Pour insérer du code : soit avec listing soit avec minted

  • Pour faire référence à une figure : utiliser \reff{fig:id-de-la-figure}

  • Pour faire référence à une référence bibliographique \citee{fig:id-de-la-ref}

  • Pour taper des quantités physiques : utiliser la commande \SI{nombre}{unités}, par exemple comme e = \SI{10}{m.kg^2/s}

Macros

\subt{texte en dessous} permet d'écrire proprement un indice de notation (donc pas une variable). Par exemple T_c signifie << température chaude >>, c n'est pas une variable mais bien l'abréviation de chaud. Il faut donc noter T\sub{c}

\supt{texte en dessous} permet d'écrire de la même façon un indice supérieur : filtre non-causal W\sub{nc}

\ud permet d'écrire proprement une différentielle, par exemple dans une intégrale : \int f(x) \ud x

\derd{f}{x} permet de taper une dérivée droite de la fonction fpar rapport à x

\derp{f}{x} permet de taper une dérivée partielle de la fonction fpar rapport à x

Comment contribuer ?

Vous pouvez m'envoyer vos suggestions à mon adresse centralienne, en me cherchant depuis l'annuaire de Zimbra.

Crédits

Je tiens à remercier en particulier, par ordre chornologique de contributions dans le projet :

  • Nicolas Gameiro, dont la première feuille de style a fourni une excellente base pour la suite ;
  • Gauthier Fanucci dont le rapport de PAr a permis de tirer quelques features intéressantes ;
  • l'équipe de la PAO mandat 2019 - 2020 en particulier Yann Zerrouk, Olivia Jeanne et Blaise (chais-pas-ton-nom déso)
  • les bêta-testeurs du code, à savoir personne.

À propos des auteurs

Bastien Laville dit le Makzer (président de la PAO mandat 2018 - 2019)

Distribution et license

MIT © Bastien Laville