Start of GUI overview

MatthiasWM · Mar 24, 2024 · 86c12f6 · 86c12f6
1 parent 8848711
commit 86c12f6
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 29 deletions.
diff --git a/fluid/documentation/Doxyfile.in b/fluid/documentation/Doxyfile.in
@@ -785,6 +785,7 @@ WARN_LOGFILE           =
 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/index.dox \
                          @CMAKE_CURRENT_SOURCE_DIR@/src/page_introduction.dox \
                          @CMAKE_CURRENT_SOURCE_DIR@/src/page_commandline.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/src/page_interactive.dox \
                          @CMAKE_CURRENT_SOURCE_DIR@/src/page_main_window.dox \
                          @CMAKE_CURRENT_SOURCE_DIR@/src/page_widgetbin_panel.dox \
                          @CMAKE_CURRENT_SOURCE_DIR@/src/page_edit_window.dox \
@@ -795,36 +796,8 @@ INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/index.dox \
                          @CMAKE_CURRENT_SOURCE_DIR@/src/page_tutorial.dox \
                          @CMAKE_CURRENT_SOURCE_DIR@/src/page_appendices.dox
 
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/page_appendices.dox
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/preface.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/intro.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/basics.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/common.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/coordinates.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/resize.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/editor.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/Fl_Terminal.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/drawing.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/events.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/subclassing.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/opengl.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/fluid.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/fltk-options.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/advanced.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/unicode.dox \
 #                         @FLTK_SOURCE_DIR@/FL \
 #                         @FLTK_SOURCE_DIR@/src \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/enumerations.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/glut.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/forms.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/osissues.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/migration_1_4.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/development.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/license.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/examples.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/faq.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/wayland.dox \
-#                         @CMAKE_CURRENT_SOURCE_DIR@/src/bundled-libs.dox
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/fluid/documentation/src/fluid_gui_overview_800.jpg b/fluid/documentation/src/fluid_gui_overview_800.jpg
diff --git a/fluid/documentation/src/index.dox b/fluid/documentation/src/index.dox
@@ -97,7 +97,7 @@
  - \ref commandline_passive
  - \ref commandline_windows
 
- \subpage page_fluid_gui
+ \subpage page_interactive
 
  \subpage page_main_window
  - \ref main_titlebar

diff --git a/fluid/documentation/src/page_interactive.dox b/fluid/documentation/src/page_interactive.dox
@@ -0,0 +1,17 @@
+/**
+
+ \page page_interactive Interactive Mode
+
+ \tableofcontents
+
+ <!-- ---------------------------------------------------------------------- -->
+ \section interactive_gui The GUI Tab
+
+ \image html fluid_gui_overview_800.jpg
+ \image latex fluid_gui_overview_800.jpg
+
+ This panel is used to edit the properties of the currently selected widgets.
+ \subpage page_edit_window
+ such as
+
+*/