From 77bf62d8ae2dfafd542864c77a3aa20598da3cbd Mon Sep 17 00:00:00 2001 From: maciej orkisz Date: Thu, 5 Mar 2009 17:44:11 +0000 Subject: [PATCH] correction Help --- kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex | 52 +++++++++++--------- 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex index 9a5e461..75ed964 100644 --- a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex +++ b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex @@ -211,28 +211,30 @@ If your aim is to write your own Packages and Black Boxes, you have to read the Just run it, typing in a console \bbStudio or clicking on its icon or its menu entry. You'll get something like in figure -\ref{bbi-fig-bbStudio-gui-start} +\ref{bbi-fig-bbStudio-gui} (the exact appearance of \bbStudio is Operating System and \bbtk version dependent). -At start, \bbStudio opens with a very minimal 'How to use' in the middle. -Don't forget to read it: it will vanish at the first mouse click. +%At start, \bbStudio opens with a very minimal 'How to use' in the middle. +%Don't forget to read it: it will vanish at the first mouse click. -\begin{figure}[!ht] -\caption{\label{bbi-fig-bbStudio-gui-start}The bbStudio Development environment interface at start time} -\begin{center} -\includegraphics[width=0.7\textwidth]{bbStudioMainPageStart.png} -\end{center} -\end{figure} - -%Let's have a look at the resized window : %\begin{figure}[!ht] -%\caption{\label{bbi-fig-bbStudio-gui}The bbStudio Development environment interface} +%\caption{The bbStudio Development environment interface at start time} %\begin{center} -%\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png} +%\includegraphics[width=0.7\textwidth]{bbStudioMainPageStart.png} %\end{center} +%\label{bbi-fig-bbStudio-gui-start} %\end{figure} +%Let's have a look at the resized window : +\begin{figure}[!ht] +\caption{The bbStudio Development environment interface} +\begin{center} +\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png} +\end{center} +\label{bbi-fig-bbStudio-gui} +\end{figure} + The interface is divided into four parts: \texttt{Files}, \texttt{Messages}, \texttt{Command}, \texttt{Help}. It is written using the Advanced User Interface library of wxWidgets @@ -248,10 +250,10 @@ Your preferences will be kept next time you run again \bbStudions. \subsubsection{'Files' part} \label{bbi-FilesPart} -It's the \bbs script editor. +It is the \bbs script editor (see section \ref{Scripting} to learn about scripting). If you load a file holding a script, it will be displayed here, and you'll be -able to modify it, to save it, to save-as it, to run it, using the +able to modify it, to save it, to save-as it and to run it, using the lower toolbar (see figure \ref{lowertoolbar}) \begin{figure}[!ht] @@ -285,12 +287,13 @@ or \texttt{std::cout} in user programs. \label{bbi-CommandPart} You can type here \bbs commands which are executed on the fly. -The buttons are shortcuts to usual commands. +The buttons are shortcuts to the most frequently used commands. +The command (or button) \texttt{help} permits to print in the \texttt{Message} zone the list of all recognized commands, while the command \texttt{help} \emph{command\_name} provides the help on the selected command. \subsubsection{'Help' part} \label{bbi-HelpContentsPart} -The 'Help' part of \bbStudio is used to browse the html help of \BBTKns. You can find there various guides (see section~\ref{sec:guides}) and detailed information about each black box available (see section~\ref{sec:boxes_help}). They can be browsed alphabetically, by package and by category. Two special categories of boxes, demos and examples, are available via direct links (see section~\ref{sec:demos_examples}). +The 'Help' part of \bbStudio is used to browse the html help of \BBTKns. You can find there various guides (see section~\ref{sec:guides}) and detailed information about each black box available (see section~\ref{sec:boxes_help}). They can be browsed alphabetically, by package and by category. Two special categories, demos and examples, are available via direct links (see section~\ref{sec:demos_examples}). % ========================================== @@ -329,7 +332,7 @@ In the 'Help' part (See figure \ref{HelpContents}), select \texttt{Examples} lin You will get a list of examples (See figure \ref{example}). -Note : due to an unfixed bug in Linux, you have to click on 'reload' to get it. \\ +Note: due to an unfixed bug in Linux, you have to click on 'reload' to get it. \\ \begin{figure}[!ht] @@ -474,19 +477,19 @@ just clicking on the button \subsection{Online Help} % ============================================== -Various levels or help are supplied by \bbStudions. +Various levels of help are supplied by \bbStudions. % ========================================== \subsubsection{Command line help} % ========================================== -The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of : +The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of: one single line area (\texttt{Command}), at the bottom, in which you can enter your commands and -a multiple line zone in which the Command interpreter prints out the result of your commands. +a multiple line zone (\texttt{Messages}) in which the command interpreter prints out the result of your commands. %The upper part contains the script editor; we shall not use it right now, you may reduce it. Command line help for the black box scripting language (\bbsns) can be obtained -in this zone (see \ref{Scripting}). +in this zone (see \ref{Scripting}). As mentioned above, the command (or button) \texttt{help} permits to print in the \texttt{Message} zone the list of all recognized commands, while the command \texttt{help} \emph{command\_name} displays in this zone the help about the selected command. The command \texttt{help} \emph{package\_name} displays in the \texttt{Message} zone a short information about the selected package, provided that this package was previously loaded. % ========================================== \subsubsection{Guides} @@ -495,8 +498,8 @@ in this zone (see \ref{Scripting}). An html version of all the guides is browsable in the \texttt{Help} part of \bbStudions. \begin{itemize} - \item {\bf\emph{User's Guide}} : This guide ! - \item {\bf\emph{Package Developper's Guide}} : Step to step How-to for programmer who wants to create his own + \item {\bf\emph{User's Guide}}: This guide ! + \item {\bf\emph{Package Developper's Guide}}: Step-by-step "How-to" for programmers who want to create their own black boxes/packages. % \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers only. (This one is probably not very much % up-to-date, since we spend more time in developping than writing documentation that's not of user concern). @@ -2544,3 +2547,4 @@ very unhappy with the result, just remove from the hidden directory \end{document} + -- 2.45.1