FLUID: More user documentation

This commit is contained in:
Matthias Melcher 2023-11-07 14:28:15 +01:00
parent 90d7737254
commit 5667dfc51b
6 changed files with 42 additions and 2 deletions

View File

@ -107,6 +107,7 @@ set ( USER_DOC_FILES
documentation/src/page_widget_types.dox
documentation/src/page_layout.dox
documentation/src/page_code_integration.dox
documentation/src/page_build_integration.dox
documentation/src/page_advanced.dox
documentation/src/page_shortcuts.dox
documentation/src/page_faqs.dox

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

View File

@ -35,7 +35,7 @@
\subpage page_introduction
_not yet_
- \ref introduction_workflow
\subpage page_getting_started
@ -61,6 +61,10 @@
_not yet_
\subpage page_build_integration
_not yet_
\subpage page_advanced
_not yet_

View File

@ -0,0 +1,9 @@
/**
\page page_build_integration Integration into Build Systems
\tableofcontents
- Explain how to integrate code into FLUID, including code nodes and event handling.
*/

View File

@ -4,6 +4,32 @@
\tableofcontents
- Provide an introduction that explains the purpose of the user manual and any prerequisites or system requirements.
The Fast Light User Interface Designer, or FLUID, is a graphical editor that
can produce ready to compile C++ source code and header files.
This user manual will introduce FLUID, starting with the installation process,
an overview of the main application window, and how to compile and run a
simple program. I will explain how to generate a more complex user interface
with three short tutorial, followed by some advanced subject like creating
integrated reusable widget classes. The appendices will sum up node types
and code generation in more detail.
\section introduction_workflow Workflow
FLUID has two modes of operation. When started from the shell without command
line arguments, or when launched from the desktop, FLUID will open in
interactive mode.
If FLUID is started from the command line with `-u`, `-c`, or `cs`, it will
not open any user interface, but instead behave like any shell-only tool that
can be easily integrated into Makefiles and build systems like CMake.
\image html fluid_flow_chart_800.png
\image latex fluid_flow_chart.png "" width=10cm
FLUID organization
More details on the command line arguments of FLUID can be found
in the chapter \ref page_build_integration .
*/