Rajout du tuto code

This commit is contained in:
leo 2020-09-25 20:32:59 +02:00
parent 26f3ed98b0
commit 7a9127358f
3 changed files with 45 additions and 104 deletions

View file

@ -14,6 +14,10 @@
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 licence. 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 licence.
### Pour un petit compte rendu
Idem, mais utilisé ```rapport_lite.tex```, qui ne contient pas d'abstract.
### Pour utiliser seulement le paquet ### Pour utiliser seulement le paquet
Copier le fichier ```ensps.sty``` dans le répertoire de votre propre rapport et utiliser le dans le code de votre fichier ```tex``` avec la commande suivante, à insérer dans le préambule : Copier le fichier ```ensps.sty``` dans le répertoire de votre propre rapport et utiliser le dans le code de votre fichier ```tex``` avec la commande suivante, à insérer dans le préambule :
@ -35,7 +39,6 @@ Copier le fichier ```ensps.sty``` dans le répertoire de votre propre rapport et
\end{figure} \end{figure}
``` ```
- Pour insérer du code : soit avec ```listing``` soit avec ```minted```. Attention : pour utiliser ```minted``` il vous faudra soit utiliser *Overleaf* (qui est très permissif niveau compilation), soit compiler ```pdflatex``` avec l'option ```--shell-escape```. Reportez-vous à la doc de votre éditeur LaTeX pour plus d'informations ;
- Pour faire référence à une figure : utiliser ```\reff{fig:id-de-la-figure}``` - Pour faire référence à une figure : utiliser ```\reff{fig:id-de-la-figure}```
@ -45,6 +48,38 @@ Copier le fichier ```ensps.sty``` dans le répertoire de votre propre rapport et
- Pour taper des quantités physiques : utiliser la commande ```\SI{nombre}{unités}```, par exemple comme ```e = \SI{1e-2}{m.kg^2/s}``` - Pour taper des quantités physiques : utiliser la commande ```\SI{nombre}{unités}```, par exemple comme ```e = \SI{1e-2}{m.kg^2/s}```
- Pour mettre en evidence un résultat : utilise l'environement ```cadregris```
```tex/tips-topten
\begin{cadregris}
RESULTAT
\end{cadregris}
```
### Insertion de code
- Pour insérer du code : soit avec ```listing``` soit avec ```minted```. Attention : pour utiliser ```minted``` il vous faudra soit utiliser *Overleaf* (qui est très permissif niveau compilation), soit compiler ```pdflatex``` avec l'option ```--shell-escape```. Reportez-vous à la doc de votre éditeur LaTeX pour plus d'informations ;
- Pour ```minted```, on a le choix entre mettre le contenu directement dans le ```.tex``` ou dans un fichier à part :
- avec le code dans le ```.tex``` , on utilise l'environement de base de ```minted``` ,
- Ou bien on utilise la commande ``` \inputminted```,
``` tex
\begin{minted}[linenos, breaklines]{python}
print("hello word")
\end{minted}
\captionof {listing}{Code python basique \label{lst:HW}}
```
``` tex
\inputminted[linenos, breaklines]{python}{hello_world.py}
\captionof {listing}{Code python basique \label{lst:HW}}
```
- On n'utilise pas l'environement ```listings``` classqieu, car si le code est trop long, il ne peut pas s'etendre sur plusieur pages. Grace à ```\captionof```, les extrait de code seront tout de même bien numérotés.
### Macros ### 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}``` - ```\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}```
@ -59,6 +94,7 @@ Copier le fichier ```ensps.sty``` dans le répertoire de votre propre rapport et
- les opérateurs différentiels tels que rot ou div sont disponibles. Notez que ces commandes sont compatibles avec le paquet ```physics```. - les opérateurs différentiels tels que rot ou div sont disponibles. Notez que ces commandes sont compatibles avec le paquet ```physics```.
-
## Ressources utiles (et pour aller plus loin) ## Ressources utiles (et pour aller plus loin)
- un peu de typographie française ; - un peu de typographie française ;

View file

@ -158,16 +158,12 @@ Pour introduire une table :
Et pour introduire du code informatique (décommenter + importer minted) : Et pour introduire du code informatique :
% Pour introduire du code informatique (décommenter, notez bien que le paquet minted est utilisable uniquement \begin{minted}[linenos, breaklines]{python}
% si vous spécifiez l'option --shell-escape lors de la compilation) print("hello word")
% \end{minted}
%\begin{listing}[ht] \captionof {listing}{Code python basique \label{lst:HW}}
%\inputminted[linenos=true, breaklines,frame=lines,framesep=2mm]{python}{code/}
%\caption{Du code informatique}
%\label{listing:id-du-code}
%\end{listing}
% -------------------------------------------------------------- % --------------------------------------------------------------

View file

@ -76,117 +76,26 @@
\pagebreak \pagebreak
% -------------------------------------------------------------- % --------------------------------------------------------------
% Début du corps % Intro
% -------------------------------------------------------------- % --------------------------------------------------------------
\section{Introduction} \section{Introduction}
\lipsum[1]
% -------------------------------------------------------------- % --------------------------------------------------------------
% Partie 1 % Corps du CR
% -------------------------------------------------------------- % --------------------------------------------------------------
\pagebreak \pagebreak
\section{Une partie}
\subsection{Une sous-partie}
Pour faire des dérivations :
\[
\derp{x}{t} + \derd{y}{t} + \derda{z}{t} + \derD{z}{t} = 0
\]
Pour faire des intégrales, le d de la différentielle est écrit avec la commande \texttt{\textbackslash ud} :
\[
\int_0^T f(t) \ud t = 0
\]
Pour utiliser des opérateurs différentiels:
\[
\div{x} + \rot{y} + \grad{z} = 0
\]
\subsection{Une autre sous-partie}
Pour mettre un encadré gris qui met un peu d'emphase :
\begin{cadregris}
Par exemple.
\end{cadregris}
Pour introduire une figure :
\begin{figure}[ht!]
\centering
\includegraphics[width=0.2\textwidth]{example-image-a}
\caption{Insérer ici le sous-titre.}
\label{fig:}
\end{figure}
Pour introduire une table :
\begin{table}[ht!]
\begin{center}
\begin{tabular}{@{}llllllll@{}}
\toprule
Un truc & & & & & & & \\ \midrule
Un autre & & & & & & & \\ \bottomrule
\end{tabular}
\caption{Un tableau \label{tab:id-de-la-table}}
\label{tab:}
\end{center}
\end{table}
Et pour introduire du code informatique (décommenter + importer minted) :
% Pour introduire du code informatique (décommenter, notez bien que le paquet minted est utilisable uniquement
% si vous spécifiez l'option --shell-escape lors de la compilation)
%
%\begin{listing}[ht]
%\inputminted[linenos=true, breaklines,frame=lines,framesep=2mm]{python}{code/}
%\caption{Du code informatique}
%\label{listing:id-du-code}
%\end{listing}
% --------------------------------------------------------------
% Partie 2
% --------------------------------------------------------------
\section{Une autre partie}
\subsection{Une autre sous-partie}
\lipsum[2]
% -------------------------------------------------------------- % --------------------------------------------------------------
% Conclusion % Conclusion
% -------------------------------------------------------------- % --------------------------------------------------------------
\pagebreak \pagebreak
\section{Conclusion} \section{Conclusion}
\lipsum[3]
\end{document} \end{document}