Skip to content

Commit

Permalink
Fixing typos, proof reading.
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthiasWM committed Apr 12, 2024
1 parent 453782f commit a1835ca
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 75 deletions.
7 changes: 3 additions & 4 deletions fluid/documentation/src/page_appendices.dox
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ On Apple computers, use the Apple Command key instead of Ctrl.
| `F8` | ungroup widgets |
| `Delete` | delete selected widgets |
| `Ctrl-1..9` | load project from history |
| `Alt-1..6` | label text tiny to huge |
| `Ctrl-A` | select all |
| `Shift-Ctrl-A` | select none |
| `Alt-B` | dhow or hide widget bin |
| `Alt-B` | show or hide Widget Bin |
| `Ctrl-C` | copy widgets |
| `Shift-Ctrl-C` | generate C++ code files |
| `Ctrl-G` | grid setting dialog |
Expand All @@ -37,7 +36,7 @@ On Apple computers, use the Apple Command key instead of Ctrl.
| `Ctrl-Q` | quit FLUID |
| `Ctrl-S` | save project |
| `Shift-Ctrl-S` | save project with new name |
| `Shift-Alt-S` | show or hide code view window |
| `Shift-Alt-S` | show or hide Code View window |
| `Ctrl-U` | duplicate selected widgets |
| `Ctrl-V` | paste last copied widgets |
| `Shift-Ctrl-W` | write i18n translation file |
Expand Down Expand Up @@ -66,7 +65,7 @@ On Apple computers, use the Apple Command key instead of Ctrl.

<!-- ---------------------------------------------------------------------- -->

\section appendix_fileformat .fl File Format
\section appendix_fileformat `.fl` File Format

FLUID edits and saves its state in `.fl` project files. These files are text,
and you can (with care) edit them in a text editor, perhaps to get some special
Expand Down
23 changes: 11 additions & 12 deletions fluid/documentation/src/page_commandline.dox
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,21 @@
\tableofcontents

FLUID can be used in interactive and in command line mode. If launched with
`-c`, followed by a project filename, it will convert the project file
`-c`, followed by a project filename, FLUID will convert the project file
into C++ source files without ever opening a window (or opening an X11 server
connection under Linux/X11). This makes FLUID a great command line tool
for build processes with complex project files that reference
external resources.

For example, a graphical image referenced by a `.fl` file can be modified
and recompiled into the application binary without the need to reload it into
an interactive FLUID session.
external resources. For example, an image referenced by a `.fl` file can be
modified and recompiled into the application binary without the need to reload
it in an interactive FLUID session.

<!-- ---------------------------------------------------------------------- -->
\section commandline_options Command Line Options

To launch FLUID from the command line, you can give it an optional name
of a project file. If no name is given, it will launch with an empty project,
or with the last open project, if so selected in the application setting dialog.
To launch FLUID in interactive mode from the command line, you can give it an
optional name of a project file. If no name is given, it will launch with an
empty project, or with the last open project, if so selected in the
application setting dialog.

The ampersand `&` is optional on Linux machines and lets FLUID run in its
own new process, giving the shell back to the caller.
Expand Down Expand Up @@ -49,14 +48,14 @@ FLUID understands all of the standard FLTK switches before the filename:
<!-- ---------------------------------------------------------------------- -->
\section commandline_passive Compile Tool Options

FLUID can also be called as a command-line tool to create the `.cxx` and `.h`
file from a `.fl` file. To do this type:
FLUID can also be called as a command-line only tool to create
the `.cxx` and `.h` file from a `.fl` file directly. To do this type:

```
fluid -c filename.fl
```

This is the same as the menu 'File/Write Code...'.
This is the same as the menu __File > Write Code...__ .
It will read the `filename.fl` file and write
`filename.cxx` and `filename.h`. Any leading
directory on `filename.fl` will be stripped, so they are
Expand Down
10 changes: 6 additions & 4 deletions fluid/documentation/src/page_interactive.dox
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
In interactive mode, FLUID allows users to construct and modify their GUI
design by organizing widgets hierarchically through drag-and-drop actions.
The project windows provide a live preview of the final UI layout.
Most widget attributes can be adjusted in detail using the widget dialog box.
Most widget attributes can be adjusted in detail using the Widget Properties
panel.

Users can also incorporate C++ coding elements such as functions, code blocks,
and classes. FLUID supports the integration of external sources, for
Expand All @@ -30,7 +31,8 @@
The layout editor window left of center, titled
"My Preferences" shows the GUI design as it will be generated by the C++
source file. The widgets "shower", "shave", and "brush teeth" are shown
in their selected state and could now be resized or moved.
in their selected state and can now be resized or moved by grabbing any of
the red boxes around the selection frame.

\see \ref page_edit_window

Expand All @@ -40,7 +42,7 @@

\see \ref page_widget_panel

The Widget Bin at the top is an optional tool bar (_Edit > SHow Widget Bin_,
The Widget Bin at the top is an optional tool bar (__Edit > Show Widget Bin__,
Alt-B). It gives quick access to all widget and code types. Widgets can
be added by clicking onto the tool, or by dragging them out of the tool box
into layout editor.
Expand All @@ -49,7 +51,7 @@

The optional panel on the right shows a live source code preview. This is
very helpful for verifying how changes in the GUI will be reflected in the
generated C++ code (_Edit > Show Source Code_, Shift-Alt-S).
generated C++ code (__Edit > Show Code View__, Shift-Alt-S).

\see \ref page_sourceview_panel

Expand Down
25 changes: 11 additions & 14 deletions fluid/documentation/src/page_introduction.dox
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
These files ultimately create an FLTK based graphical user interface
for an application.

The FLTK programming manual is available at https://www.fltk.org/documentation.php .

This manual provides instructions on launching FLUID as a command line tool
and integrating `.fl` project files into the application build process.
FLTK utilizes `cmake`, but other build systems and IDEs capable of running
external tools can also build applications based on FLUID.

The FLTK programming manual is available at https://www.fltk.org/documentation.php .

The majority of the manual focuses on using FLUID as an interactive GUI
design tool. It covers an overview of windows, menu items, and dialog boxes,
detailing how to create visually appealing and consistent user experiences
Expand All @@ -26,14 +26,10 @@
a new project, creating an alignment template, and incorporating
internationalization.

In a few tutorials, we will explain how to generate small apps in FLUID alone,
Several tutorials will explain how to generate small apps in FLUID alone,
and how to create more complex user interfaces, followed by some advanced
subject like creating integrated reusable widget classes.

Several tutorials demonstrate creating simple applications using FLUID
exclusively, as well as developing more intricate user interfaces. Advanced
topics such as creating reusable widget classes are also discussed.

The appendices contain additional technical information for reference.

<!-- ---------------------------------------------------------------------- -->
Expand All @@ -46,25 +42,26 @@
Subsequently, these files are compiled into object files, which are then
linked with other object files to form an executable binary.
FLUID-generated header files give access to UI elements from other C++ modules
within the project. Conversely, FLUID can also generate references to
variables and callback functions in other C++ modules.
within the project. FLUID can also generate forward declarations to
variables and callback functions that are defined and implemented in other
C++ modules.

\image html fluid_flow_chart_800.png "FLUID Workflow"
\image latex fluid_flow_chart.png "FLUID Workflow"

Small applications can be fully designed and developed within FLUID. Users
have the option to include shell scripts in FLUID projects, enabling them to
directly call compilers and linkers to produce the binaries.
Small applications can be fully designed and developed with FLUID alone.
Users have the option to include shell scripts in FLUID projects, enabling
them to directly call compilers and linkers to produce the binaries.

For medium-sized projects, a build systems such as `cmake` or IDEs
with integrated build setups is recommended. FLUID in interactive mode
can pre-generate C++ code files for direct compilation by the IDE.

In larger projects, FLUID projects frequently reference external resources
such as graphics, binary data, and internationalized text.
In such scenarios,it is very useful to distribute the `.fl` project files
In such scenarios, it is very useful to distribute the `.fl` project files
instead of prebuilt source files. FLUID in command-line mode can then be
called as an external tool, dynamically generating C++ source code from all
external resources during compile time.
external resources at compile time.

*/
4 changes: 2 additions & 2 deletions fluid/documentation/src/page_main_window.dox
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

A FLUID project is a hierarchy of nodes. Each node holds information to
generates C++ source code which in turn generates the user interface that
is created in the layout editor windows. Project usually define one or more
is created in the layout editor windows. Projects usually define one or more
functions, or methods in a classes. These functions can generate one or more
FLTK windows and all the widgets that go inside those windows.

Expand Down Expand Up @@ -70,7 +70,7 @@
The *Shell* menu gives quick access to user definable shell scripts. Note that
scripts can be stored inside `.fl` project files.

\see main_menu_items
\see \ref main_menu_items

<!-- ---------------------------------------------------------------------- -->
\section main_widget_browser Widget Tree View
Expand Down
50 changes: 27 additions & 23 deletions fluid/documentation/src/page_setting_dialog.dox
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
and project setting in a compact set of six tabs.

The *General* tab contains a collection of application wide setting. They are
stored in the user preferences.
stored as a user preferences.

The *Project* tab holds settings for the current project. They are saved with
the `.fl` file.
Expand All @@ -20,11 +20,11 @@
preferences can be saved per user, or as part of the project, or exported for
use in other projects.

The *Shell* tabs manages databases of quick access shell commands and scripts.
The *Shell* tabs manages a database of quick access shell commands and scripts.
Shell commands can be saved as a user preference and also as part of the
`.fl` project file.

The *Locale* tab set the method of internationalizing texts in the project,
The *Locale* tab sets the method of internationalizing texts in the project,
commonly used for labels and tooltips.

The *User* tab manages customization of fonts and colors in the widget browser.
Expand All @@ -38,7 +38,7 @@
<img src="w_settings_general_tab.png" align="left" hspace="10" vspace="10" />
\image latex w_settings_general_tab.png

__Scheme__ :
__Scheme__:

Select one of the graphics schemes built into FLTK. It's helpful
to verify the look of various schemes for an application design.
Expand Down Expand Up @@ -79,19 +79,21 @@
and source file. If one field is empty the value defaults to `.h` and `.cxx`
respectively. If a name starts with a `.`, FLUID assumes that the rest of the
text is a file extension. The code file name is then generated by replacing
the extension of the `.fl` file name.
the extension of the `.fl` project file name.

\todo Explain the entire process of calculating the path.
\todo Document the exact way the source and header file paths are calculated
for interactive FLUID, and for FLUID launched form the command line.

__Include Header from Code__:

If checked, an include statement is generated close to the start of the
source file.
If checked, the statement to include the header file is automatically
generated in one of the first lines of the source file.

__Menu shortcuts use FL_COMMAND__:

Setting this option will replace FL_CTRL and FL_META as a modifier for
shortcuts with the platform aware modifiers FL_COMMAND and FL_CONTROL.
shortcuts with the platform aware modifiers FL_COMMAND and FL_CONTROL, making
shortcuts more portable between macOS and Windows/Linux.

__allow Unicode__:

Expand All @@ -102,7 +104,7 @@

FLUID by default includes `<FL/Fl.H>` early in the header file. If this option
is checked, users can include other files before including the FL header. The
user must then include `<FL/Fl.H>` later with a Declaration node.
user must then include `<FL/Fl.H>` later using a Declaration node.

<div style="clear:both;"></div>

Expand All @@ -119,10 +121,12 @@
__Layout__:

The layout pulldown menu lets users choose from a list of existing layouts.
The plus button creates a new set of layouts based on the currently selected.
The plus button creates a new set of layouts based on the currently selected
layout.
The pulldown menu has items to rename, load, and save layouts. It can also
change the location where the layout is stored. The FLUID beaker is for
internal layouts, the portrait icon stores as user preference,, the document
layouts that are predefined in FLUID, the portrait icon stores as user
preference, the document
icon stores the layout in the `.fl` file, and the disk icon lets users store
layout in external files.

Expand All @@ -138,18 +142,18 @@

__Tabs Margin__:

Snap the tab in side `Fl_Tabs` to the tab border and the offset given in
Snap the tab inside `Fl_Tabs` to the tab border and the offset given in
Margins.

__Widget Minimum, Increment, and Gap__:

Minimum set the minimal width of a widget. Increment is the size multiplier
on top of the Minimum value. Gap is the preferred distance to other widgets
_Minimum_ set the minimal width of a widget. _Increment_ is the size multiplier
added to the _Minimum_ value. _Gap_ is the preferred distance to other widgets
in the same group

__Label Font__, __Text Font__:

The preferred label and text font for new widgets.
The preferred label and text font and size for new widgets.

<div style="clear:both;"></div>

Expand All @@ -165,22 +169,22 @@
of the name indicates that the script is stored in the user preferences. The
document symbol saves them within the `.fl` project file.

`[+]` add a fresh new script to the list, `[++]` duplicates the currently
`[+]` adds a fresh new script to the list, `[++]` duplicates the currently
selected script. `[DEL]` deletes it, and `[v]` offers import and export
functionality. The `[T]` button shows the terminal window, and finally the
`[>]` button runs the selected shell script.
`[Run]` button runs the selected shell script.

Selecting a shell script will fill in the bottom half of the dialog.

__Name__:

This is the name of the script as it appears in the prowser.
This is the name of the script as it appears in the Shell Command List.

__Menu Label__:

Shell scripts that match the *Condition* flag are also available for quick
access in the *Shell* menu in the main window. This is the text that is used
for the menu entry.
access in the *Shell* menu in the main window and via shortcut keys
combination. This is the text that is used for the menu entry.

__Shortcut__:

Expand All @@ -205,8 +209,8 @@
of variables that are replaced with the corresponding value before running
the script. The zoom button gives access to a much larger shell script editor.

The options below are a list of actions that will be executed before running
the script if checked.
The options below are a list of actions that can be executed before running
the script.

<div style="clear:both;"></div>

Expand Down
Loading

0 comments on commit a1835ca

Please sign in to comment.