diff --git a/CMakeLists.txt b/CMakeLists.txt index 5f41312..6a83039 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -390,6 +390,7 @@ else (WIN32) install (FILES LICENSE NEWS DESTINATION share/doc/${PROJECT_NAME}) endif (WIN32) +install (DIRECTORY docs/user-guide DESTINATION share/doc/${PROJECT_NAME}) install (DIRECTORY share/gui share/library DESTINATION share/${PROJECT_NAME}) install (FILES ${GSETTINGS_SCHEMAS} DESTINATION share/glib-2.0/schemas) install (CODE " # DESTDIR is not in use on Windows (WIN32 is only native here!) diff --git a/docs/user-guide/stylesheet.css b/docs/user-guide/stylesheet.css new file mode 100644 index 0000000..7e3b47e --- /dev/null +++ b/docs/user-guide/stylesheet.css @@ -0,0 +1,7 @@ +body { max-width: 50em; margin: 0 auto 4em auto; padding: 0 2em; + font-family: sans-serif; } h1, h2, h3 { font-weight: normal; } +h1 { font-size: 2.5em; } h2 { font-size: 2em; } h3 { font-size: 1.33em; } +h2 { padding-top: .67em; border-top: 1px solid silver; } +p { line-height: 1.5; } .figure { text-align: center; } img { max-width: 100%; } +q { font-style: normal; } .details { border-bottom: 1px solid silver; } +.details br { display: none; } .details br + span:before { content: " — "; } diff --git a/docs/user-guide/user-guide-cs.asciidoc b/docs/user-guide/user-guide-cs.asciidoc deleted file mode 100644 index acb50f5..0000000 --- a/docs/user-guide/user-guide-cs.asciidoc +++ /dev/null @@ -1,148 +0,0 @@ -// 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 Eric Janouch -v0.2.0, 2018-06-27 -: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. - -[[gitea-download]] -.Nabídka pro stahování na stráncách projektu -image::gitea.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 -<>. 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 a přetažením -myší do diagramu na požadované umístění. - -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. - diff --git a/docs/user-guide/user-guide-cs.html b/docs/user-guide/user-guide-cs.html new file mode 100644 index 0000000..868d50d --- /dev/null +++ b/docs/user-guide/user-guide-cs.html @@ -0,0 +1,141 @@ + + + + +logdiag: Průvodce uživatele + + + + + +

logdiag: Průvodce uživatele

+ +

+Přemysl Eric Janouch
+p@janouch.name
+verze 0.2.0, +2018-06-27 + +

Okno programu logdiag + +

Ú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. + +

Gitea +
Obrázek 1: Nabídka pro stahování na stránkách projektu + +

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. + +

Pozor: 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

+

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. + +

+Výběr objektů +
Obrázek 2: Výběr objektů v oblasti + +

Alternativně můžete táhnout myší z volné oblasti diagramu do prostoru, viz +Obrázek 2. 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 +a přetažením myší do diagramu na požadované umístění. + +

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. + +

+Začátek operace + …  +Konec operace +
Obrázek 3: Propojení terminálů dvou značek + +

Č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. + + diff --git a/docs/user-guide/user-guide-en.asciidoc b/docs/user-guide/user-guide-en.asciidoc deleted file mode 100644 index 8f7a51c..0000000 --- a/docs/user-guide/user-guide-en.asciidoc +++ /dev/null @@ -1,146 +0,0 @@ -// 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 Eric Janouch -v0.2.0, 2018-06-27 -: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. - -[[gitea-download]] -.The download menu on the project site -image::gitea.png[] - -While on the web, look for a tab entitled ``Releases'' and click on it. A list -of 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 <>. 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 and dragging it onto the diagram where you want the -symbol to be placed. - -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. - diff --git a/docs/user-guide/user-guide-en.html b/docs/user-guide/user-guide-en.html new file mode 100644 index 0000000..91731e0 --- /dev/null +++ b/docs/user-guide/user-guide-en.html @@ -0,0 +1,133 @@ + + + + +logdiag: User Guide + + + + + +

logdiag: User Guide

+ +

+Přemysl Eric Janouch
+p@janouch.name
+version 0.2.0, +2018-06-27 + +

logdiag program window + +

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. + +

Gitea +
Figure 1: The download menu on the project site + +

While on the web, look for a tab entitled Releases and click on it. +A list of 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

+

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. + +

+select objects +
Figure 2: Selecting objects inside an area + +

Alternatively drag the mouse from free space within the diagram into +the area, see Figure 2. 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 and dragging it onto the diagram where you want +the symbol to be placed. + +

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. + +

+Start of operation + …  +End of operation +
Figure 3: Interconnecting terminals of two symbols + +

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. + +