Abandon LaTeX in favor of AsciiDoc
While we've lost precise control over the output, there's a lot less noise in the files and we've gained a cheap way of producing user documentation in the HTML format. Apparently I was eyeing DocBook all those years ago as well. I /think/ it proved to be a little bit too hard to write that way, or to get visually satisfying results. Nonetheless, the raw format is capable of specifying figures with multiple pictures, so we might want to revisit the idea some other day. The documents have been slightly updated to reflect the "recent" changes in program function and hosting. Some issues have also been corrected in the English translation.
This commit is contained in:
parent
96fd6b6f24
commit
45842016eb
GPG Key ID:
A0420B94F92B9493
|
|
@ -0,0 +1,153 @@
|
|||
// TODO: nakonfigurovat v CMake asciidoctor-pdf, je potřeba pár `gem install`
|
||||
// https://github.com/asciidoctor/asciidoctor-pdf/blob/master/README.adoc
|
||||
// https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc
|
||||
|
||||
logdiag: Průvodce uživatele
|
||||
===========================
|
||||
Přemysl Janouch <p@janouch.name>
|
||||
v0.2, 2018-06-25
|
||||
:toc: left
|
||||
:toc-title: Obsah
|
||||
:sectnums:
|
||||
:warning-caption: VAROVÁNÍ
|
||||
:xrefstyle: short
|
||||
:figure-caption: Obrázek
|
||||
|
||||
image::logdiag-cs.png[]
|
||||
|
||||
<<<
|
||||
|
||||
Úvod
|
||||
----
|
||||
Tento dokument vás má za účel provést po aplikaci a pomoci vám se v ní
|
||||
zorientovat. Popis úkonů se přednostně vztahuje na operační systém Microsoft
|
||||
Windows, do jisté míry je však platný i pro jiné operační systémy.
|
||||
|
||||
Získání aplikace
|
||||
----------------
|
||||
Nejnovější verzi aplikace je možné stáhnout na následující webové adrese:
|
||||
https://git.janouch.name/p/logdiag.
|
||||
|
||||
// TODO: aktualizovat obrázek pro anglickou Gitea
|
||||
[[github-download]]
|
||||
.Nabídka pro stahování na GitHubu
|
||||
image::github.png[]
|
||||
|
||||
Až se ocitnete na webu, vyhledejte v záhlaví záložku s nápisem ``Releases'' a
|
||||
klepněte na ni. Zobrazí se přehled vydání a pod hlavičkami ``Downloads''
|
||||
související soubory ke stažení. Instalační soubor pro Microsoft Windows nese
|
||||
název ve stylu ``logdiag-__verze__-Windows-x86.exe''.
|
||||
|
||||
Instalace
|
||||
---------
|
||||
Proces instalace je velmi přímočarý. Po úvodní obrazovce je vyžadován souhlas s
|
||||
licencí. Pokud nerozumíte anglicky, její stručné shrnutí zní, že aplikaci smíte
|
||||
v nezměněné formě zcela volně používat a redistribuovat, ale nejsou vám
|
||||
poskytovány žádné záruky. Následuje výběr složky, do které chcete aplikaci
|
||||
nainstalovat, a složky pro umístění ve Start menu. V případě, že nenastala žádná
|
||||
náhlá chyba, už jen stačí potvrdit úspěšnou instalaci.
|
||||
|
||||
WARNING: Pokud aplikaci instalujete do složky, kde se nachází již existující
|
||||
instalace, mohou nastat potíže. Ačkoliv je to možné, nepokoušejte se z těch
|
||||
samých příčin instalovat ani více kopií vedle sebe. Nejdříve stávající instalaci
|
||||
odstraňte, například pomocí zástupce umístěného ve Start menu.
|
||||
|
||||
Operace s objekty
|
||||
-----------------
|
||||
|
||||
////
|
||||
|
||||
TODO: zkusit restrukturalizovat na:
|
||||
|
||||
4. Operace s objekty
|
||||
4.1 Základní operace
|
||||
4.1.1 Výběr
|
||||
4.1.2 Přesun
|
||||
4.1.3 Odstranění
|
||||
4.2 Značky
|
||||
4.2.1 Vložení
|
||||
4.2.2 Otáčení
|
||||
4.3 Spojení
|
||||
4.3.1 Tvorba
|
||||
|
||||
////
|
||||
|
||||
Každý diagram je tvořen z objektů, a s těmi se sdružují dále popsané operace.
|
||||
Budete-li chtít momentálně prováděnou operaci zrušit, můžete tak obvykle učinit
|
||||
stiskem klávesy Escape.
|
||||
|
||||
Výběr objektů
|
||||
~~~~~~~~~~~~~
|
||||
Jednotlivé objekty můžete vybírat levým kliknutím myší. Ty se v reakci na to
|
||||
vyznačí červenou barvou. Chcete-li vybrat objektů více, držte během klikání
|
||||
stisknutou klávesu Shift.
|
||||
|
||||
// XXX: nelze zarovnat obrázek na střed zároveň s caption
|
||||
[[select-objects]]
|
||||
.Výběr objektů v oblasti
|
||||
image::select-objects.png[]
|
||||
|
||||
Alternativně můžete táhnout myší z volné oblasti diagramu do prostoru, viz
|
||||
<<select-objects>>. Vyberou se objekty obsažené ve vytvořeném obdélníku. Výběr
|
||||
lze zrušit klepnutím na prázdné místo.
|
||||
|
||||
Přesun objektů
|
||||
~~~~~~~~~~~~~~
|
||||
Přesun objektů se provede tažením objektů myší na požadované místo. Pokud jsou
|
||||
tyto objekty součástí výběru, přesune se celý výběr. Ten lze též přesouvat
|
||||
pomocí kurzorových kláves.
|
||||
|
||||
Odstranění objektů
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Objekty odstraníte stisknutím klávesy Delete, případně z menu aplikace.
|
||||
|
||||
Vložení značky
|
||||
~~~~~~~~~~~~~~
|
||||
_Značky_ představují nejdůležitější druh objektů. Do diagramu je vložíte výběrem
|
||||
z nabídky značek umístěné po levé straně hlavního okna aplikace, viz
|
||||
<<select-symbol>>, a přetažením myší do diagramu na požadované umístění.
|
||||
|
||||
[[select-symbol]]
|
||||
.Výběr značky z nabídky
|
||||
image::select-symbol.png[]
|
||||
|
||||
Otáčení značek
|
||||
~~~~~~~~~~~~~~
|
||||
Otočit značku vloženou do diagramu můžete přes pravé tlačítko myši.
|
||||
|
||||
Propojení terminálů
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
_Terminálem_ se nazývá bod určený pro tvorbu spojení mezi značkami nebo jinými
|
||||
spojeními. Abyste z něj spojení vyvedli, nejdříve na něj najeďte kurzorem myši
|
||||
tak, aby se viditelně vyznačil kroužkem. Pak stiskněte levé tlačítko myši a
|
||||
přetáhněte kurzor myši na místo, kde chcete, aby spojení končilo.
|
||||
|
||||
// XXX: nelze sloučit do jedné figure
|
||||
[[create-connection]]
|
||||
.Propojení terminálů dvou značek
|
||||
image:create-connection-begin.png[]
|
||||
...
|
||||
image:create-connection-end.png[]
|
||||
|
||||
Časté problémy
|
||||
--------------
|
||||
|
||||
Nelze otevřít uložený diagram
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Při ukládání se ujistěte, že zadaný název souboru obsahuje příponu ``.ldd''. V
|
||||
opačném případě se nezobrazí v dialogu pro otevření diagramu. Pokud jste nějaký
|
||||
soubor již bez přípony uložili, napravíte to dodatečným přidáním přípony k jeho
|
||||
názvu.
|
||||
|
||||
Jak můžu diagram vytisknout?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Současná verze aplikace není schopná přímo tisknout. Pro vytištění vytvořeného
|
||||
diagramu můžete klávesou PrintScreen sejmout snímek obrazovky, vložit jej
|
||||
například do aplikace Malování, oříznout požadovanou část a vytisknout ji z
|
||||
tohoto grafického editoru.
|
||||
|
||||
Schází mi popisky
|
||||
~~~~~~~~~~~~~~~~~
|
||||
Obdobně jako v předchozím případě tato funkcionalita zatím neexistuje, ale je
|
||||
možné tento nedostatek obejít přes běžný grafický editor.
|
||||
|
||||
|
|
@ -1,148 +0,0 @@
|
|||
%&program=xelatex
|
||||
%&encoding=UTF-8 Unicode
|
||||
|
||||
\documentclass[12pt,oneside,a4paper,titlepage,final]{article}
|
||||
\usepackage{fontspec}
|
||||
\usepackage{indentfirst}
|
||||
\usepackage{setspace}
|
||||
\usepackage{graphicx}
|
||||
\usepackage[czech]{babel}
|
||||
\usepackage[pdfborder={0 0 0},pdfpagelabels=true,plainpages=false]{hyperref}
|
||||
\usepackage[all]{hypcap}
|
||||
|
||||
\usepackage{amsmath}
|
||||
\usepackage{amsthm}
|
||||
|
||||
\newtheoremstyle{note}{\parskip}{0pt}{}{\parindent}{\bfseries}{:}{.5em}{}
|
||||
\theoremstyle{note}
|
||||
\newtheorem*{warning}{Pozor}
|
||||
|
||||
% Better quotations
|
||||
\renewcommand*{\uv}[1]{\quotedblbase #1\textquotedblleft}
|
||||
|
||||
% Metadata
|
||||
\newcommand{\gettitle}{logdiag}
|
||||
\newcommand{\getsubtitle}{Průvodce uživatele}
|
||||
\newcommand{\getauthor}{Přemysl Janouch}
|
||||
\newcommand{\getdate}{6. března 2011}
|
||||
|
||||
\hypersetup{pdftitle={\gettitle{} --- \getsubtitle},pdfauthor={\getauthor}}
|
||||
|
||||
\begin{document}
|
||||
|
||||
% Number the first pages with roman numerals
|
||||
\renewcommand{\thepage}{\roman{page}}
|
||||
|
||||
% The title page has no header or footer at all
|
||||
\thispagestyle{empty}
|
||||
|
||||
\begin{center}
|
||||
\doublespacing
|
||||
\textbf{\LARGE\gettitle}\\{\Large\getsubtitle}
|
||||
\par\getauthor
|
||||
\par\getdate
|
||||
\vfill
|
||||
\includegraphics{logdiag-cs}
|
||||
\newpage
|
||||
\end{center}
|
||||
|
||||
\tableofcontents
|
||||
\newpage
|
||||
|
||||
% Number the real content with arabic numerals and show them in the footer
|
||||
\renewcommand{\thepage}{\arabic{page}}
|
||||
\setcounter{page}{1}
|
||||
|
||||
\section{Úvod}
|
||||
Tento dokument vás má za účel provést po aplikaci a~pomoci vám se v~ní zorientovat. Popis úkonů se přednostně vztahuje na operační systém Microsoft Windows, do jisté míry je však platný i~pro jiné operační systémy.
|
||||
|
||||
\section{Získání aplikace}
|
||||
Nejnovější verzi aplikace je možné stáhnout na následující webové adrese: \mbox{\url{http://github.com/pjanouch/logdiag}}.
|
||||
|
||||
\begin{figure}[ht]
|
||||
\centering
|
||||
\includegraphics[width=\textwidth,keepaspectratio]{github}
|
||||
\caption{Nabídka pro stahování na githubu}
|
||||
\label{github-download}
|
||||
\end{figure}
|
||||
|
||||
Až se ocitnete na githubu, vyhledejte po pravé straně tlačítko s~nápisem \uv{Downloads}, případně \uv{Soubory ke stažení}, a~klepněte na něj. Zobrazí se před vámi nabídka balíčků. Instalační soubor pro Microsoft Windows nese název ve stylu \uv{logdiag-\emph{verze}-Windows-x86.exe}.
|
||||
|
||||
\section{Instalace}
|
||||
Proces instalace je velmi přímočarý. Po úvodní obrazovce je vyžadován souhlas s~licencí. Pokud nerozumíte anglicky, její stručné shrnutí zní, že aplikaci smíte v~nezměněné formě zcela volně používat a~redistribuovat, ale nejsou vám poskytovány žádné záruky. Následuje výběr složky, do které chcete aplikaci nainstalovat, a~složky pro umístění ve Start menu. V~případě, že nenastala žádná náhlá chyba, už jen stačí potvrdit úspěšnou instalaci.
|
||||
|
||||
\begin{warning}
|
||||
Pokud aplikaci instalujete do složky, kde se nachází již existující instalace, mohou nastat potíže. Ačkoliv je to možné, nepokoušejte se z~těch samých příčin instalovat ani více kopií vedle sebe. Nejdříve stávající instalaci odstraňte, například pomocí zástupce umístěného ve Start menu.
|
||||
\end{warning}
|
||||
|
||||
\section{Operace s~objekty}
|
||||
% TODO: Zkusit restrukturalizovat na:
|
||||
|
||||
% 4. Operace s objekty
|
||||
% 4.1 Základní operace
|
||||
% 4.1.1 Výběr
|
||||
% 4.1.2 Přesun
|
||||
% 4.1.3 Odstranění
|
||||
% 4.2 Značky
|
||||
% 4.2.1 Vložení
|
||||
% 4.2.2 Otáčení
|
||||
% 4.3 Spojení
|
||||
% 4.3.1 Tvorba
|
||||
%
|
||||
|
||||
Každý diagram je tvořen z~objektů, a~s~těmi se sdružují dále popsané operace. Budete-li chtít momentálně prováděnou operaci zrušit, můžete tak obvykle učinit stiskem klávesy Escape.
|
||||
|
||||
\subsection{Výběr objektů}
|
||||
Jednotlivé objekty můžete vybírat levým kliknutím myší. Ty se v~reakci na to vyznačí červenou barvou. Chcete-li vybrat objektů více, držte během klikání stisknutou klávesu Shift.
|
||||
|
||||
\begin{figure}[ht]
|
||||
\centering
|
||||
\includegraphics{select-objects}
|
||||
\caption{Výběr objektů v~oblasti}
|
||||
\label{select-objects}
|
||||
\end{figure}
|
||||
|
||||
Alternativně můžete táhnout myší z~volné oblasti diagramu do prostoru, viz obrázek \ref{select-objects}. Vyberou se objekty obsažené ve vytvořeném obdélníku. Výběr lze zrušit klepnutím na prázdné místo.
|
||||
|
||||
\subsection{Přesun objektů}
|
||||
Přesun objektů se provede tažením objektů myší na požadované místo. Pokud jsou tyto objekty součástí výběru, přesune se celý výběr. Ten lze též přesouvat pomocí kurzorových kláves.
|
||||
|
||||
\subsection{Odstranění objektů}
|
||||
Objekty odstraníte stisknutím klávesy Delete, případně z~menu aplikace.
|
||||
|
||||
\subsection{Vložení značky}
|
||||
\emph{Značky} představují nejdůležitější druh objektů. Do diagramu je vložíte výběrem z~nabídky značek umístěné po~levé straně hlavního okna aplikace, viz obrázek \ref{select-symbol}. Po kliknutí na vámi vybranou značku klikněte znovu do diagramu na místo, kde ji chcete umístit.
|
||||
|
||||
\begin{figure}[ht]
|
||||
\centering
|
||||
\includegraphics{select-symbol}
|
||||
\caption{Výběr značky z~nabídky}
|
||||
\label{select-symbol}
|
||||
\end{figure}
|
||||
|
||||
\subsection{Otáčení značek}
|
||||
Otočit značku vloženou do diagramu můžete přes pravé tlačítko myši.
|
||||
|
||||
\subsection{Propojení terminálů}
|
||||
\emph{Terminálem} se nazývá bod určený pro tvorbu spojení mezi značkami nebo jinými spojeními. Abyste z~něj spojení vyvedli, nejdříve na něj najeďte kurzorem myši tak, aby se viditelně vyznačil kroužkem. Pak stiskněte levé tlačítko myši a~přetáhněte kurzor myši na místo, kde chcete, aby spojení končilo.
|
||||
|
||||
\begin{figure}[ht]
|
||||
\centering
|
||||
\includegraphics{create-connection-begin} \hspace{15pt} \includegraphics{create-connection-end}
|
||||
\caption{Propojení terminálů dvou značek}
|
||||
\label{create-connection}
|
||||
\end{figure}
|
||||
|
||||
\section{Časté problémy}
|
||||
\subsection{Nelze otevřít uložený diagram}
|
||||
Při ukládání se ujistěte, že zadaný název souboru obsahuje příponu \uv{.ldd}. V~opačném případě se nezobrazí v~dialogu pro otevření diagramu. Pokud jste nějaký soubor již bez přípony uložili, napravíte to dodatečným přidáním přípony k~jeho názvu.
|
||||
|
||||
\subsection{Jak můžu diagram vytisknout?}
|
||||
Současná verze aplikace není schopná přímo tisknout. Pro vytištění vytvořeného diagramu můžete klávesou PrintScreen sejmout snímek obrazovky, vložit jej například do aplikace Malování, oříznout požadovanou část a~vytisknout ji z~tohoto grafického editoru.
|
||||
|
||||
\subsection{Schází mi popisky}
|
||||
Obdobně jako v~předchozím případě tato funkcionalita zatím neexistuje, ale je možné tento nedostatek obejít přes běžný grafický editor.
|
||||
|
||||
\end{document}
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,151 @@
|
|||
// TODO: nakonfigurovat v CMake asciidoctor-pdf, je potřeba pár `gem install`
|
||||
// https://github.com/asciidoctor/asciidoctor-pdf/blob/master/README.adoc
|
||||
// https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc
|
||||
|
||||
logdiag: User Guide
|
||||
===================
|
||||
Přemysl Janouch <p@janouch.name>
|
||||
v0.2, 2018-06-25
|
||||
:toc: left
|
||||
:sectnums:
|
||||
:xrefstyle: short
|
||||
|
||||
image::logdiag-en.png[]
|
||||
|
||||
<<<
|
||||
|
||||
Introduction
|
||||
------------
|
||||
This document will guide you through the application and help to familiarize you
|
||||
with it. The description of tasks mainly targets the Microsoft Windows
|
||||
operating system, though it's also valid for other operating systems to
|
||||
a certain extent.
|
||||
|
||||
Getting the application
|
||||
-----------------------
|
||||
Download the newest version of the application at the following web address:
|
||||
https://git.janouch.name/p/logdiag.
|
||||
|
||||
// TODO: aktualizovat obrázek pro anglickou Gitea
|
||||
[[github-download]]
|
||||
.The download menu at GitHub
|
||||
image::github.png[]
|
||||
|
||||
While on the web, look for a tab entitled ``Releases'' and click on it. A menu
|
||||
with versions will appear with files for download listed under ``Downloads''
|
||||
headings. The installation file for Microsoft Windows is named in the style of
|
||||
``logdiag-__version__-Windows-x86.exe''.
|
||||
|
||||
Installation
|
||||
------------
|
||||
The installation process is quite straight-forward. After the initial screen a
|
||||
license agreement is required. Next, choose a folder in which to install the
|
||||
application and another one for placement in the Start menu. So long as no
|
||||
unexpected errors have occurred, all that's left is confirming a successful
|
||||
installation.
|
||||
|
||||
WARNING: If the application is installed into a folder where a previous
|
||||
installation is already located, problems may arise. Although it is possible to
|
||||
do so, don't try to install multiple copies parallely either, for the same
|
||||
reasons. Remove the current installation first, for example by using the
|
||||
shortcut located in the Start menu.
|
||||
|
||||
Operations with objects
|
||||
-----------------------
|
||||
|
||||
////
|
||||
|
||||
TODO: zkusit restrukturalizovat na:
|
||||
|
||||
4. Operace s objekty
|
||||
4.1 Základní operace
|
||||
4.1.1 Výběr
|
||||
4.1.2 Přesun
|
||||
4.1.3 Odstranění
|
||||
4.2 Značky
|
||||
4.2.1 Vložení
|
||||
4.2.2 Otáčení
|
||||
4.3 Spojení
|
||||
4.3.1 Tvorba
|
||||
|
||||
////
|
||||
|
||||
Each diagram consists of objects, and these are accompanied by the operations
|
||||
described below. To cancel any current operation, press the Escape key.
|
||||
|
||||
Selecting objects
|
||||
~~~~~~~~~~~~~~~~~
|
||||
Select single objects by left-clicking on them. They will get highlighted with
|
||||
red color in reaction to this. To select multiple objects, hold the Shift key
|
||||
while clicking.
|
||||
|
||||
// XXX: nelze zarovnat obrázek na střed zároveň s caption
|
||||
[[select-objects]]
|
||||
.Selecting objects inside an area
|
||||
image::select-objects.png[]
|
||||
|
||||
Alternatively drag the mouse from free space within the diagram into the area,
|
||||
see <<select-objects>>. Objects contained in this rectangle will be
|
||||
selected. The selection may later be dismissed by just clicking into free space.
|
||||
|
||||
Moving objects
|
||||
~~~~~~~~~~~~~~
|
||||
Moving of objects is done by dragging them with the mouse onto the desired
|
||||
place. If these objects form a part of the current selection, the whole
|
||||
selection is moved. The selection may also be moved using cursor keys.
|
||||
|
||||
Removing objects
|
||||
~~~~~~~~~~~~~~~~
|
||||
Remove objects either by pressing the Delete key or from the application menu.
|
||||
|
||||
Inserting symbols
|
||||
~~~~~~~~~~~~~~~~~
|
||||
_Symbols_ constitute the most important kind of objects. Insert them into the
|
||||
diagram by choosing one from the symbol menu located on the left side of the
|
||||
main application window, see <<select-symbol>>, and dragging it onto the diagram
|
||||
where you want the symbol to be placed.
|
||||
|
||||
[[select-symbol]]
|
||||
.Choosing a symbol from the menu
|
||||
image::select-symbol.png[]
|
||||
|
||||
Rotating symbols
|
||||
~~~~~~~~~~~~~~~~
|
||||
Rotate a symbol inserted into the diagram by right-clicking on it.
|
||||
|
||||
Connecting terminals
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
A point intended for creation of connections between symbols or other
|
||||
connections is called a _terminal_. To lead a connection out of it, first
|
||||
hover it with the mouse pointer, so it gets visibly highlighted with a circle.
|
||||
Then press the left mouse button and drag the pointer onto the place where you
|
||||
want the connection to end.
|
||||
|
||||
// XXX: nelze sloučit do jedné figure
|
||||
[[create-connection]]
|
||||
.Interconnecting terminals of two symbols
|
||||
image:create-connection-begin.png[]
|
||||
...
|
||||
image:create-connection-end.png[]
|
||||
|
||||
Frequent problems
|
||||
-----------------
|
||||
|
||||
Can't open a saved diagram
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
When saving, ensure that the filename you've typed in contains the ``.ldd''
|
||||
suffix. If not, it won't show up in the dialog for opening diagrams. In case
|
||||
you've already saved a file without an extension, you may fix this situation by
|
||||
adding the suffix to its name.
|
||||
|
||||
How do I print a diagram?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
The current version of application is not able to print directly. To print out a
|
||||
created diagram, you may use the PrintScreen key to capture a screenshot, then
|
||||
insert it to, for example, Paint, and print it from inside the graphics editor.
|
||||
|
||||
I miss labels
|
||||
~~~~~~~~~~~~~
|
||||
Similarly to the previous case, this functionality doesn't exist yet, but it is
|
||||
possible to get around this limitation using a graphics editor.
|
||||
|
||||
|
|
@ -1,134 +0,0 @@
|
|||
%&program=xelatex
|
||||
%&encoding=UTF-8 Unicode
|
||||
|
||||
\documentclass[12pt,oneside,a4paper,titlepage,final]{article}
|
||||
\usepackage{fontspec}
|
||||
\usepackage{indentfirst}
|
||||
\usepackage{setspace}
|
||||
\usepackage{graphicx}
|
||||
\usepackage[english]{babel}
|
||||
\usepackage[pdfborder={0 0 0},pdfpagelabels=true,plainpages=false]{hyperref}
|
||||
\usepackage[all]{hypcap}
|
||||
|
||||
\usepackage{amsmath}
|
||||
\usepackage{amsthm}
|
||||
|
||||
\newtheoremstyle{note}{\parskip}{0pt}{}{\parindent}{\bfseries}{:}{.5em}{}
|
||||
\theoremstyle{note}
|
||||
\newtheorem*{warning}{Warning}
|
||||
|
||||
% Better quotations
|
||||
\newcommand*{\uv}[1]{"#1"}
|
||||
|
||||
% Metadata
|
||||
\newcommand{\gettitle}{logdiag}
|
||||
\newcommand{\getsubtitle}{User Guide}
|
||||
\newcommand{\getauthor}{Přemysl Janouch}
|
||||
\newcommand{\getdate}{6. March 2011}
|
||||
|
||||
\hypersetup{pdftitle={\gettitle{} --- \getsubtitle},pdfauthor={\getauthor}}
|
||||
|
||||
\begin{document}
|
||||
|
||||
% Number the first pages with roman numerals
|
||||
\renewcommand{\thepage}{\roman{page}}
|
||||
|
||||
% The title page has no header or footer at all
|
||||
\thispagestyle{empty}
|
||||
|
||||
\begin{center}
|
||||
\doublespacing
|
||||
\textbf{\LARGE\gettitle}\\{\Large\getsubtitle}
|
||||
\par\getauthor
|
||||
\par\getdate
|
||||
\vfill
|
||||
\includegraphics{logdiag-en}
|
||||
\newpage
|
||||
\end{center}
|
||||
|
||||
\tableofcontents
|
||||
\newpage
|
||||
|
||||
% Number the real content with arabic numerals and show them in the footer
|
||||
\renewcommand{\thepage}{\arabic{page}}
|
||||
\setcounter{page}{1}
|
||||
|
||||
\section{Introduction}
|
||||
This document will guide you through the application and help to familiarize you with it. The description of tasks is preferentially related to the Microsoft Windows operating system, though it's also valid for other operating systems to a certain extent.
|
||||
|
||||
\section{Getting the application}
|
||||
Download the newest version of the application at the following web address: \mbox{\url{http://github.com/pjanouch/logdiag}}.
|
||||
|
||||
\begin{figure}[ht]
|
||||
\centering
|
||||
\includegraphics[width=\textwidth,keepaspectratio]{github}
|
||||
\caption{The download menu at github}
|
||||
\label{github-download}
|
||||
\end{figure}
|
||||
|
||||
While at github, look for a button entitled \uv{Downloads} at the right side of the page and click on it. A menu with packages appears. The installation file for Microsoft Windows is named \uv{logdiag-\emph{version}-Windows-x86.exe}.
|
||||
|
||||
\section{Installation}
|
||||
The installation process is quite straight-forward. After the initial screen the license agreement is required. Next, choose a folder in which to install the application and another one for placement in the Start menu. As long as no unexpected error has occurred, all that's left is confirming a successful installation.
|
||||
|
||||
\begin{warning}
|
||||
If the application is installed to a folder where a previous installation is already located, problems may arise. Although it is possible to do so, don't try to install multiple copies parallely either, for the same reasons. Remove the current installation first, for example by using the shortcut located in the Start menu.
|
||||
\end{warning}
|
||||
|
||||
\section{Operations with objects}
|
||||
Each diagram consists of objects, and these are joined with the operations described below. To cancel any current operation, press the Escape key.
|
||||
|
||||
\subsection{Selecting objects}
|
||||
Select single objects by left-clicking on them. They will get highlighted with red color in reaction to this. To select multiple objects, hold the Shift key while clicking.
|
||||
|
||||
\begin{figure}[ht]
|
||||
\centering
|
||||
\includegraphics{select-objects}
|
||||
\caption{Selecting objects inside an area}
|
||||
\label{select-objects}
|
||||
\end{figure}
|
||||
|
||||
Alternatively drag the mouse from free space within the diagram into the area, see figure \ref{select-objects}. Objects contained in this rectangle will be selected. The selection may later be dismissed by just clicking into free space.
|
||||
|
||||
\subsection{Moving objects}
|
||||
Moving of objects is done by dragging them with the mouse onto the desired place. If these objects form a part of the current selection, the whole selection is moved. The selection may also be moved using cursor keys.
|
||||
|
||||
\subsection{Removing objects}
|
||||
Remove objects either by pressing the Delete key or from the application menu.
|
||||
|
||||
\subsection{Inserting symbols}
|
||||
\emph{Symbols} constitute the most important kind of objects. Insert them into the diagram by choosing one from the symbol menu located at the left side of the main application window, see figure \ref{select-symbol}. After clicking on a symbol, click again into the diagram where the symbol is to be placed.
|
||||
|
||||
\begin{figure}[ht]
|
||||
\centering
|
||||
\includegraphics{select-symbol}
|
||||
\caption{Choosing a symbol from the menu}
|
||||
\label{select-symbol}
|
||||
\end{figure}
|
||||
|
||||
\subsection{Rotating symbols}
|
||||
Rotate a symbol inserted into the diagram by right-clicking on it.
|
||||
|
||||
\subsection{Connecting terminals}
|
||||
A point intended for creation of connections between symbols or other connections is called a \emph{terminal}. To lead a connection out of it, first hover it with the mouse pointer, so it gets visibly highlighted with a circle. Then press the left mouse button and drag the pointer onto the place where you want the connection to end.
|
||||
|
||||
\begin{figure}[ht]
|
||||
\centering
|
||||
\includegraphics{create-connection-begin} \hspace{15pt} \includegraphics{create-connection-end}
|
||||
\caption{Interconnecting terminals of two symbols}
|
||||
\label{create-connection}
|
||||
\end{figure}
|
||||
|
||||
\section{Frequent problems}
|
||||
\subsection{Can't open a saved diagram}
|
||||
When saving, assure that the filename you've typed in contains the \uv{.ldd} suffix. If not, it won't show up in the dialog for opening diagrams. In case you've already saved a file without an extension, you may fix this situation by adding the suffix to its name.
|
||||
|
||||
\subsection{How do I print a diagram?}
|
||||
The current version of application is not able to print directly. To print out a created diagram, you may use the PrintScreen key to capture a screenshot, then insert it to, for example, Paint, and print it from inside the graphics editor.
|
||||
|
||||
\subsection{I miss labels}
|
||||
Similarly to the previous case, this functionality doesn't exist yet, but it is possible to get around this limitation via a regular graphics editor.
|
||||
|
||||
\end{document}
|
||||
|
||||
|
||||
Loading…
Reference in New Issue