summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Melcher <github@matthiasm.com>2022-11-16 19:50:03 +0100
committerGitHub <noreply@github.com>2022-11-16 19:50:03 +0100
commit24c4af6440c9aaf93ef211f70ae98f1c4873e420 (patch)
tree913ce4935ae798c6daede8635250a25d71994759
parent85c941b8fe24c855968a67c99e3f865752c68a47 (diff)
Capitalise FLTK and FLUID.
-rw-r--r--fluid/README_fl.txt58
1 files changed, 29 insertions, 29 deletions
diff --git a/fluid/README_fl.txt b/fluid/README_fl.txt
index 62db7fc27..3b65360ae 100644
--- a/fluid/README_fl.txt
+++ b/fluid/README_fl.txt
@@ -9,40 +9,40 @@ all elements of the format and its caveats.
History
-------
-Fluid, the Fast Light User Interface Designer was started in the 1990's loosely
+FLUID, the Fast Light User Interface Designer was started in the 1990's loosely
based on 'fdesign', a GUI designer that came with the 'Forms Library', later
-'XForms Library'. Fluid's .fl file format was originally compatible with the
+'XForms Library'. FLUID's .fl file format was originally compatible with the
fdesign '.fd' format, but evolved somewhat ad hoc to become what it is today.
Basics
======
-Fluid is a visual editor, storing the user interface description in .fl files
-with the ability to create ready-to-compile C++ code. Fluid can also be used
+FLUID is a visual editor, storing the user interface description in .fl files
+with the ability to create ready-to-compile C++ code. FLUID can also be used
as a command line tool to translate .fl files directly into source code. It
can be integrated into build scripts and most IDEs as an external tool.
.fl files describe a hierarchical graphical user interface for the 'FLTK'
library as a tree structure. Elements in the tree can be FLTK Widgets as well
as functional components like classes, C++ functions, variables, etc. .
-Fluid calls all elements in the hierarchy 'Type'.
+FLUID calls all elements in the hierarchy 'Type'.
Line Endings
------------
-Although Fluid writes all line endings as '\n', readers should tolerate '\r\n'
-MSWindows line endings as well. Except for the Header, the Fluid reader does not
+Although FLUID writes all line endings as '\n', readers should tolerate '\r\n'
+MSWindows line endings as well. Except for the Header, the FLUID reader does not
differentiate between a line ending and a space character outside of a 'word'.
Unicode
-------
-Fluid does not handle UTF-8 characters in any special manner (unescaped),
+FLUID does not handle UTF-8 characters in any special manner (unescaped),
but stores and reads them verbatim, making UTF-8 character sequences perfectly
-legal in .fl files. Fluid can translate UTF-8 into escape sequence when writing
+legal in .fl files. FLUID can translate UTF-8 into escape sequence when writing
source code files.
@@ -87,7 +87,7 @@ Note: As there are no defined start and end markers to a String, a reader must
know when these Strings appear and be prepared to read them correctly,
even if the String itself is not useful to the reader.
-Note: All Strings that are generated by the current Fluid source code
+Note: All Strings that are generated by the current FLUID source code
can be read back as a single Word.
@@ -117,19 +117,19 @@ followed by a newline, followed by
version <float v>
wehere 'v' is the version number as in FL_VERSION (major*1.0 + minor * 0.01
-+ patch * 0.0001). So for fltk 1.3.4, 'v' would be 1.0304
++ patch * 0.0001). So for FLTK 1.3.4, 'v' would be 1.0304
-Note: the version number corresponds not so much to the version of Fluid, but
- to the version of the underlying fltk library. So unless the version of
- fltk is finalised, the file format in the GitHub master branch can still
+Note: the version number corresponds not so much to the version of FLUID, but
+ to the version of the underlying FLTK library. So unless the version of
+ FLTK is finalised, the file format in the GitHub master branch can still
change unexpectedly.
-Note: if the version number is above the internal version number, Fluid will
+Note: if the version number is above the internal version number, FLUID will
report an error and continue reading, hoping for the best.
- There are no other uses inside the Fluid reader except for fltk2 features
+ There are no other uses inside the FLUID reader except for fltk2 features
which is beyond the scope of this document.
-Note: fdesign files (.fd) start with the text "Magic:". Fluid can read these
+Note: fdesign files (.fd) start with the text "Magic:". FLUID can read these
files, but Forms/XForms files are beyond the scope of this document.
@@ -139,7 +139,7 @@ Options
Options are usually comprised of a Word, two Words, or a Word and a String. If
an Option is missing, a default value is assumed.
- "Magic:" : used by fdesign, not written by Fluid
+ "Magic:" : used by fdesign, not written by FLUID
"define_in_struct" : no longer used
@@ -167,7 +167,7 @@ an Option is missing, a default value is assumed.
"i18n_conditional" <word> : string
"header_name" <word> : can be the full filename, or just the
- extension e.g. “.h” in which case Fluid will use the same filename
+ extension e.g. “.h” in which case FLUID will use the same filename
as the .fl file.
"code_name" <word> : can be the full filename, or just the
@@ -183,9 +183,9 @@ Note: There is no keyword that marks the end of the Options section. The
Option list ends when a Word is not in the Options list and it is in
the list of known Types.
- If the Word is neither an Option nor a vaild Type, Fluid will give an
+ If the Word is neither an Option nor a vaild Type, FLUID will give an
error message and try to continue to read the file. Using new Option
- keywords makes .fl files incompatible to earlier versions of Fluid.
+ keywords makes .fl files incompatible to earlier versions of FLUID.
Due to the forgiving interpreter, files may still be read correctly
despite error messages.
@@ -233,11 +233,11 @@ Note: the "class" Type has an additional Word following immediately after
Types
-----
-Type names are based on fltk class names. Types derive properties from super
-Types loosely similar to fltk.
+Type names are based on FLTK class names. Types derive properties from super
+Types loosely similar to FLTK.
Note: the hierarchical dependency is implemented twice and somewhat conflicting
- in Fluid via the Fl_..._Type hierarchy, and by using '::is_some_type()'
+ in FLUID via the Fl_..._Type hierarchy, and by using '::is_some_type()'
virtual functions, which does not always match the Type hierarchy.
@@ -325,7 +325,7 @@ Type Fl_Type <word>
“user_data_type” <word> : usually “void*” or “long”
“callback” <word> : a function name or a function body
“comment” <word> : one or many lines of text
- “open” : Group content visible in the Fluid tree browser
+ “open” : Group content visible in the FLUID tree browser
“selected” : Type was selected in tree view
Type "Function" <word> : function signature
@@ -382,9 +382,9 @@ Type "Fl_Widget" <word> : C++ variable name
"image" <word> : image name
"deimage" <word> : deactivated image name
"type" <word> : integer
- "box" <word> : text or integer (see fltk boxtypes)
+ "box" <word> : text or integer (see FLTK boxtypes)
"down_box" <word> : (is_button() or Fl_Input_choice" or is_menu_button())
- text or integer (see fltk boxtypes)
+ text or integer (see FLTK boxtypes)
"value" <word> : (is_button()) integer
"value" <word> : (is_valuator(), is_spinner()) double
"color" <word> :
@@ -434,9 +434,9 @@ Type "Fl_Window" <word> : C++ variable name
none or "modal", or "non_modal": defaults to not modal (which is
different to non_modal!)
- "visible" : show window when opening file in Fluid
+ "visible" : show window when opening file in FLUID
"noborder" : borderless window
- "xclass" <word> : see fltk
+ "xclass" <word> : see FLTK
"size_range" : this Word is written with printf as "{%d %d %d %d}",
min_w, min_h, max_w, max_h
"xywh" <word> : this Word is written with printf as "{%d %d %d %d}",