Skip to content

Commit

Permalink
User guide translated to english (invesalius#87)
Browse files Browse the repository at this point in the history
User guide translated to english
  • Loading branch information
paulojamorim authored and tfmoraes committed May 22, 2017
1 parent f278649 commit 9795351
Show file tree
Hide file tree
Showing 515 changed files with 3,036 additions and 97 deletions.
14 changes: 13 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,16 @@ build
*.cpp
*.diff

*.directory
*.directory


# latex
*.aux
*.toc
*.bbl
*.blg
*.fls
*.fdb_latexmk
*.synctex.gz
*.out
*.log
Binary file added docs/user_guide_en.pdf
Binary file not shown.
13 changes: 13 additions & 0 deletions docs/user_guide_en_source/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
all:
pdflatex user_guide_en
bibtex user_guide_en
pdflatex user_guide_en
pdflatex user_guide_en
clean:
rm -f *.dvi *.log *.toc *.aux *.bbl *.blg *.loa *.los *.out *.cb

cleanall:
rm -f user_guide_en.pdf *.dvi *.log *.toc *.aux *.bbl *.blg *.loa *.los *.out *.cb

move:
mv -f user_guide_en.pdf ../user_guide_en.pdf
50 changes: 50 additions & 0 deletions docs/user_guide_en_source/autores.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
\scalebox{2.0}{\sffamily Authors}
\\

Paulo Henrique Junqueira Amorim

\href{mailto:[email protected]}{[email protected]}
\\


Thiago Franco de Moraes

\href{mailto:[email protected]}{[email protected]}
\\


Fábio de Souza Azevedo

\href{mailto:[email protected]}{[email protected]}
\\


André Salles Cunha Peres (Neuronavigator)

\href{mailto:[email protected]}{[email protected]}
\\


Victor Hugo de Oliveira e Souza (Neuronavigator)

\href{mailto:[email protected]}{[email protected]}
\\


Renan Hiroshi Matsuda (Neuronavigator)

\href{mailto:renan\[email protected]}{renan\_[email protected]}
\\


Oswaldo Baffa Filho (Neuronavigator)

\href{mailto:[email protected]}{[email protected]}
\\


Jorge Vicente Lopes da Silva

\href{mailto:[email protected]}{[email protected]}
\\

100 changes: 100 additions & 0 deletions docs/user_guide_en_source/cap_cust.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
\chapter{Customization}

Some customization options are available for InVesalius users. They are shown as follow.

\section{Tools menu}

To hide/show the side tools menu, click the button shown in figure
\ref{fig:layout_full_original}.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.5]{layout_full_original}
\caption{Shortcut to hide/show side tools menu}
\label{fig:layout_full_original}
\end{figure}

With the menu hidden, the image visualization area in InVeslaius is expanded, as illustrated in figure \ref{fig:closed_tool_menu}.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.4]{window_mpr_not_painels_en.png}
\caption{Side menu hidden}
\label{fig:closed_tool_menu}
\end{figure}

\newpage

\section{Automatic positioning of volume/surface}

To automatic set the visualization position of a volume or surface,
click on the icon shown in figure \ref{fig:3d_automatic_position}
(located in the inferior right corner of InVesalius screen) and choose one of the available options for visualization.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.45]{3d_automatic_position_en.png}
\caption{Options for visualization positioning}
\label{fig:3d_automatic_position}
\end{figure}

\section{Background color of volume/surface window}

To change the background color of volume/surface window, click on the shortcut shown in figure
\ref{fig:button_select_color_2}. The shortcut is also located in the inferior right cornen of InVesalius screen.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.8]{colour_button_en.png}
\caption{Shortcut to background color of volume/surface window}
\label{fig:button_select_color_2}
\end{figure}

A window for color selection opens, as in figure \ref{fig:color_window_background}.
Next, just click over the desired color and then click \textbf{OK}.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.6]{surface_select_color_windows_so_en.png}
\caption{Background color selection}
\label{fig:color_window_background}
\end{figure}

The figure \ref{fig:background_color} illustrates the correspondent window with modified background color.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.7]{3d_background_changed.png}
\caption{Background color modified}
\label{fig:background_color}
\end{figure}

\newpage

\section{Show/hide text in 2D windows}

To show or hide the texts in 2D image windows, click in the shortcut illustrated
in figure \ref{fig:text}, located in tools bar.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.7]{text}
\caption{Shorcut to show or hide texts}
\label{fig:text}
\end{figure}

Figures \ref{fig:text_on} and \ref{fig:text_off} exhibit texts enabled and disabled, respectively.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.5]{axial_en.png}
\caption{Show texts enabled}
\label{fig:text_on}
\end{figure}

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.5]{axial_no_tex_en.png}
\caption{Show texts disabled}
\label{fig:text_off}
\end{figure}
97 changes: 97 additions & 0 deletions docs/user_guide_en_source/cap_export.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
\chapter{Data export}

InVesalius allows to export data in different formats, such as OBJ, STL and others, to be used in other software.

Menu to export data is located in the left panel of InVesalius,
inside item \textbf{4. Export data}. If the menu is not visible, double-click with \textbf{left} mouse button
to expand the item. Figure \ref{fig:data_export} exhibit this menu.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.8]{painel_data_export_en.png}
\caption{Menu to export data}
\label{fig:data_export}
\end{figure}

\section{Surface}

To export a surface, select it from the data menu as shown in
figure \ref{fig:data_export_selection}.

\newpage

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.7]{painel_data_export_selection_en.png}
\caption{Select surface to be exported}
\label{fig:data_export_selection}
\end{figure}

Next, click on the icon shown in figure \ref{fig:surface_export_original}.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.2]{surface_export_original}
\caption{Shortcut to export surface}
\label{fig:surface_export_original}
\end{figure}

In the correspondent window (figure \ref{fig:export_data_window}), tyoe the file name and
select the desired exported format. Finally, click \textbf{Save}.


\begin{figure}[!htb]
\centering
\includegraphics[scale=0.4]{export_surface_en.png}
\caption{Window to export surface}
\label{fig:export_data_window}
\end{figure}

Files formats avaiable for exportation are listed in table
\ref{tab:files_export_list}:

\begin{table}[h]
\centering
\caption{File formats exported by InVesalius}
\begin{tabular}{lcc}\\
\hline % este comando coloca uma linha na tabela
Format & Extension\\
\hline
\hline
Inventor & .iv\\
Polygon File Format & .ply\\
Renderman & .rib\\
Stereolithography (formato binário)& .stl\\
Stereolithography (formato ASCII) & .stl\\
VRML & .vrml\\
VTK PolyData & .vtp\\
Wavefront & .obj\\
\hline
\end{tabular}
\label{tab:files_export_list}
\end{table}


\section{Image}

Images exhibited in any orientation (axial, coronal,
sagittal and 3D) can be exported. To do so, click with mouse \textbf{left} button on the shortcut
shown in figure \ref{fig:menu_save_image_window} and select the sub-window related to the target
image to be exported.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.5]{menu_save_image_window_en.png}
\caption{Menu to export images}
\label{fig:menu_save_image_window}
\end{figure}

On the windown shown (figure \ref{fig:save_image_window}), select the desired file cormat and click
on the button \textbf{Save}.

\begin{figure}[!htb]
\centering
\includegraphics[scale=0.4]{export_bmp_en.png}
\caption{Window to export images}
\label{fig:save_image_window}
\end{figure}
Loading

0 comments on commit 9795351

Please sign in to comment.