.. -*- Mode: rst -*-

.. role:: raw-latex(raw)
   :format: latex

.. URLs that changes between the various backends.
.. _Coriolis Tools Documentation:   https://www-soc.lip6.fr/sesi-docs/coriolis2-docs/coriolis2/
.. _Stratus Documentation:          https://www-soc.lip6.fr/sesi-docs/coriolis2-docs/coriolis2/en/html/stratus/index.html

.. |DONE|                           replace:: :raw-latex:`\marginpar{\fbox{\small\ding{56}}}`

.. For LaTeX/PDF backend.
.. |Key_ESC|                        replace:: :raw-latex:`\key{ESC}\xspace`
.. |Key_CTRL|                       replace:: :raw-latex:`\key{CTRL}\xspace`
.. |Key_Up|                         replace:: :raw-latex:`\key{Up}\xspace`
.. |Key_Down|                       replace:: :raw-latex:`\key{Down}\xspace`
.. |Key_Left|                       replace:: :raw-latex:`\key{Left}\xspace`
.. |Key_Right|                      replace:: :raw-latex:`\key{Right}\xspace`
.. |Key_f|                          replace:: :raw-latex:`\key{f}\xspace`
.. |Key_G|                          replace:: :raw-latex:`\key{G}\xspace`
.. |Key_i|                          replace:: :raw-latex:`\key{i}\xspace`
.. |Key_l|                          replace:: :raw-latex:`\key{l}\xspace`
.. |Key_m|                          replace:: :raw-latex:`\key{m}\xspace`
.. |Key_k|                          replace:: :raw-latex:`\key{k}\xspace`
.. |Key_K|                          replace:: :raw-latex:`\key{K}\xspace`
.. |Key_o|                          replace:: :raw-latex:`\key{o}\xspace`
.. |Key_p|                          replace:: :raw-latex:`\key{p}\xspace`
.. |Key_q|                          replace:: :raw-latex:`\key{q}\xspace`
.. |Key_w|                          replace:: :raw-latex:`\key{w}\xspace`
.. |Key_S|                          replace:: :raw-latex:`\key{S}\xspace`
.. |Key_z|                          replace:: :raw-latex:`\key{z}\xspace`
.. |Plus|                           replace:: :raw-latex:`$+$\xspace`
.. |rightarrow|                     replace:: :raw-latex:`$\rightarrow$`
.. |menu_P&R|                       replace:: :raw-latex:`\fbox{\textsf{\textbf{{P\&R}}}}`
.. |menu_StepByStep|                replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{S}tep by Step}}}}`
.. |menu_KiteSaveGlobalRouting|     replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{S}ave Global Routing}}}}`
.. |menu_KiteLoadGlobalRouting|     replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{L}oad Global Routing}}}}`
.. |menu_KiteGlobalRoute|           replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{G}lobal Route}}}}`
.. |menu_KiteDetailedRoute|         replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{D}etailed Route}}}}`
.. |menu_KiteFinalizeRoute|         replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{F}inalize Route}}}}`

.. Stand-alone images.
.. |ViewerSnapshot_1|               replace:: :raw-latex:`\begin{center}\fbox{\includegraphics[width=.7\textwidth]{./images/Viewer-1.eps}}\end{center}`
.. |ControllerSnapshot_1|           replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-1.eps}\end{center}`
.. |ControllerLook_1|               replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Look-1.eps}\end{center}`
.. |ControllerFilter_1|             replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Filter-1.eps}\end{center}`
.. |ControllerLayersGos_1|          replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-LayersGos-1.eps}\end{center}`
.. |ControllerNetlist_1|            replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Netlist-1.eps}\end{center}`
.. |ViewerNetlist_1|                replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Viewer-Netlist-1.eps}\end{center}`
.. |ControllerSelection_1|          replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Selection-1.eps}\end{center}`
.. |ControllerInspector_1|          replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Inspector-1.eps}\end{center}`
.. |ControllerInspector_2|          replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Inspector-2.eps}\end{center}`
.. |ControllerInspector_3|          replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Inspector-3.eps}\end{center}`
.. |ControllerSettings_1|           replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Settings-1.eps}\end{center}`

.. |BigMouse|                       image:: ./images/ComputerMouse.eps
                                    :scale: 25%

.. Direct LaTeX commands encapsulation.
.. |dotfill|                        replace:: :raw-latex:`\dotfill`
.. |noindent|                       replace:: :raw-latex:`\noindent`
.. |medskip|                        replace:: :raw-latex:`\medskip`
.. |newpage|                        replace:: :raw-latex:`\newpage`