summaryrefslogtreecommitdiff
path: root/fluid/documentation/src-dev/page_introduction.dox
diff options
context:
space:
mode:
authorMatthias Melcher <github@matthiasm.com>2023-11-05 16:12:15 +0100
committerMatthias Melcher <github@matthiasm.com>2023-11-05 16:12:15 +0100
commita31409f7bbe7db51f63c79b16358d64ae6e2d4bb (patch)
tree5b8816c025fe6ed407eb54008ef3e86ebf780c68 /fluid/documentation/src-dev/page_introduction.dox
parent681363849c032df345b1d4177c98f52cbc5f82fe (diff)
FLUID: Documentation
Diffstat (limited to 'fluid/documentation/src-dev/page_introduction.dox')
-rw-r--r--fluid/documentation/src-dev/page_introduction.dox60
1 files changed, 59 insertions, 1 deletions
diff --git a/fluid/documentation/src-dev/page_introduction.dox b/fluid/documentation/src-dev/page_introduction.dox
index 417f9e5db..1db902d44 100644
--- a/fluid/documentation/src-dev/page_introduction.dox
+++ b/fluid/documentation/src-dev/page_introduction.dox
@@ -4,6 +4,64 @@
\tableofcontents
- - Provide an introduction that explains the purpose of the user manual and any prerequisites or system requirements.
+ ## Light User Interface Design ##
+
+ FLUID is the Fast Light User Interface Designer that accompanies the fltk
+ user interface library. FLUID relies on panels and dialogs that are generated
+ within FLUID. Consequently, developers are required to consistently assess the
+ user-friendliness and code integrity of the application.
+
+ This document presumes you are familiar with FLUID, have read the most
+ important parts the FLUID User Manual, and have created some user interfaces
+ in FLUID already.
+
+ ## History ##
+
+ FLUID is an application that grew over time with fltk. In its original design,
+ it was meant to allow users to drag and resize a limited number of widgets
+ for small dialog boxes. As the feature set grew over time, new concept and
+ designs were introduced by new authors. In its current state, FLUID's source
+ code is largely undocumented and difficult to read and understand.
+
+ This should not stop you from diving into the code though. The concepts and
+ ideas behind FLUID are great. The software itself is very usable and stable.
+ And while digging through the code, any addition to the documentation is
+ highly appreciated.
+
+ ## Future ##
+
+ As we approach the imminent release of FLTK 1.4.0, FLUID will no longer undergo
+ significant feature enhancements. Instead, the focus will shift towards
+ documentation improvements, addressing bugs, and enhancing usability for
+ recent FLTK additions such as Fl_Grid and Fl_Flex. Following the release of
+ 1.4.0, FLUID will undergo a comprehensive restructuring and modernization,
+ streamlining maintenance and simplifying the process of integrating
+ support for new widgets.
+
+ ## Quick Glossary ##
+
+ __Project__ : a project is a single design, stored in a project file ending in
+ `.fl`. A project contains a bunch of settings and a tree of Types. One
+ project can contain multiple UI designs.
+
+ __Code File__, __Header File__ : by default, FLUID generates C++ source code
+ that is stored in two files with the same basename as the project. The
+ C++ declarations go into the header file ending in `.h`, and the
+ implementation is stored in the `.cxx` source code file.
+
+ __Strings File__ : FLUID supports internationalization (in short i18n) of all
+ know text elements in a project. The Strings file can be generated as a
+ base for adding new languages. The file extension depend on the chosen
+ i18ns library.
+
+ __Types__ : a type is a node in a tree that manages a widget or a functional
+ node like Class, Function, CodeBlock, etc.
+
+ __Panels__ : in its interactive incarnation, FLUID provides a number of panels
+ (dialog boxes) for editing all aspects of Types.
+
+ ## Basic Structure ##
+
+ ...
*/