diff options
Diffstat (limited to 'examples/assistant/simpletextviewer/documentation')
16 files changed, 325 insertions, 0 deletions
diff --git a/examples/assistant/simpletextviewer/documentation/about.txt b/examples/assistant/simpletextviewer/documentation/about.txt new file mode 100644 index 0000000..eeab35f --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/about.txt @@ -0,0 +1,9 @@ +The Simple Text Viewer enables the user to select and view existing +files. + +HTML files is displayed using rich text, while other files are +presented as plain text. The application provides a file dialog +allowing the user to search for files using wildcard matching. The +search is performed within in the specified directory, and the user is +given an option to browse the existing file system to find the +relevant directory. diff --git a/examples/assistant/simpletextviewer/documentation/browse.html b/examples/assistant/simpletextviewer/documentation/browse.html new file mode 100644 index 0000000..987abf3 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/browse.html @@ -0,0 +1,34 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Browse</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Browse</h2></center></p> + + <p> + The file dialog let you browse the current file system to + specify the directory in which the file you want to open + resides. + Note that only the specified directory will be searched, any + subdirectories will simply be ignored. + </p> + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/browse.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + See also: <a href="filedialog.html">File Dialog</a>, <a href="wildcardmatching.html">Wildcard Matching</a>, + <a href="findfile.html">Find File</a> + </p> + </body> +</html> + diff --git a/examples/assistant/simpletextviewer/documentation/filedialog.html b/examples/assistant/simpletextviewer/documentation/filedialog.html new file mode 100644 index 0000000..afa65ed --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/filedialog.html @@ -0,0 +1,48 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>File Dialog</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>File Dialog</h2></center></p> + + <p> + In the file dialog you can name a particular file name, or + search for files using wildcard matching, i.e. specify a + file name containing wildcards. In addition you must specify + the directory in which the file you search for resides. + </p> + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/filedialog.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + By default the dialog will search for all files (*) in the + current directory (the directory the application is run from). + </p> + + <p> + When editing the file name and directory parameters, an + overview of the matching files are displayed in the + dialog. The overview is updated whenever the parameters + change. + </p> + + <br /> + <br /> + <p> + See also: <a href="browse.html">Browse</a>, <a href="wildcardmatching.html">Wildcard Matching</a>, + <a href="findfile.html">Find File</a> + </p> + </body> +</html> + + diff --git a/examples/assistant/simpletextviewer/documentation/findfile.html b/examples/assistant/simpletextviewer/documentation/findfile.html new file mode 100644 index 0000000..32e0147 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/findfile.html @@ -0,0 +1,32 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Find File</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Find File</h2></center></p> + + <p> + To open and view a file in the Simple Text Viewer, select the + 'Open...' option in the 'File' menu. The application will then + provide you with a file dialog that you can use to search for + any existing file. + </p> + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/fadedfilemenu.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + See also: <a href="openfile.html">Open File</a>, <a href="filedialog.html">File Dialog</a> + </p> + </body> +</html> + diff --git a/examples/assistant/simpletextviewer/documentation/images/browse.png b/examples/assistant/simpletextviewer/documentation/images/browse.png Binary files differnew file mode 100644 index 0000000..86db6b1 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/images/browse.png diff --git a/examples/assistant/simpletextviewer/documentation/images/fadedfilemenu.png b/examples/assistant/simpletextviewer/documentation/images/fadedfilemenu.png Binary files differnew file mode 100644 index 0000000..fde0e43 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/images/fadedfilemenu.png diff --git a/examples/assistant/simpletextviewer/documentation/images/filedialog.png b/examples/assistant/simpletextviewer/documentation/images/filedialog.png Binary files differnew file mode 100644 index 0000000..883a33a --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/images/filedialog.png diff --git a/examples/assistant/simpletextviewer/documentation/images/handbook.png b/examples/assistant/simpletextviewer/documentation/images/handbook.png Binary files differnew file mode 100644 index 0000000..3bd2b92 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/images/handbook.png diff --git a/examples/assistant/simpletextviewer/documentation/images/mainwindow.png b/examples/assistant/simpletextviewer/documentation/images/mainwindow.png Binary files differnew file mode 100644 index 0000000..c28d5e9 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/images/mainwindow.png diff --git a/examples/assistant/simpletextviewer/documentation/images/open.png b/examples/assistant/simpletextviewer/documentation/images/open.png Binary files differnew file mode 100644 index 0000000..1e5bba3 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/images/open.png diff --git a/examples/assistant/simpletextviewer/documentation/images/wildcard.png b/examples/assistant/simpletextviewer/documentation/images/wildcard.png Binary files differnew file mode 100644 index 0000000..6e83a56 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/images/wildcard.png diff --git a/examples/assistant/simpletextviewer/documentation/index.html b/examples/assistant/simpletextviewer/documentation/index.html new file mode 100644 index 0000000..5a7b1d5 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/index.html @@ -0,0 +1,41 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Manual</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Simple Text Viewer</h2></center></p> + + <p> + The Simple Text Viewer enables the user to select and view + existing files. + </p> + + <p><center> + <img src="images/mainwindow.png" /> + </center></p> + + <p> + HTML files is displayed using rich text, while + other files are presented as plain text. The application + provides a file dialog allowing the user to search for files + using wildcard matching. The search is performed within in the + specified directory, and the user is given an option to browse + the existing file system to find the relevant directory. + </p> + + <ul> + <li><a href="findfile.html">Find File</a></li> + <ul> + <li><a href="filedialog.html">File Dialog</a></li> + <li><a href="wildcardmatching.html">WildCard Matching</a></li> + <li><a href="browse.html">Browse</a></li> + </ul> + <li><a href="openfile.html">Open File</a></li> + </ul> + </body> +</html> + + + diff --git a/examples/assistant/simpletextviewer/documentation/intro.html b/examples/assistant/simpletextviewer/documentation/intro.html new file mode 100644 index 0000000..2e2aa40 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/intro.html @@ -0,0 +1,28 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Manual</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Simple Text Viewer</h2></center></p> + + <p> + The Simple Text Viewer enables the user to select and view + existing files. + </p> + + <p><center> + <img src="images/mainwindow.png" /> + </center></p> + + <p> + The application provides its own custom documentation that is + available through the <b>Help</b> menu in the main window's menubar + and through the <b>Help</b> button in the application's find file + dialog. + </p> + + </body> +</html> + diff --git a/examples/assistant/simpletextviewer/documentation/openfile.html b/examples/assistant/simpletextviewer/documentation/openfile.html new file mode 100644 index 0000000..e172de9 --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/openfile.html @@ -0,0 +1,36 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Open File</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Open File</h2></center></p> + + <p> + Once the file you want to view appears in the dialog's + display, you can open it in two different ways. + </p> + + <p> + By pressing the 'Open' button the currently selected file will + be opened. By default, the first file in the list of matching + files is selected. Another way of opening a file is to simply + double click the displayed file name. + </p> + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/open.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + See also: <a href="findfile.html">Find File</a> + </p> + </body> +</html> diff --git a/examples/assistant/simpletextviewer/documentation/simpletextviewer.adp b/examples/assistant/simpletextviewer/documentation/simpletextviewer.adp new file mode 100644 index 0000000..660df4f --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/simpletextviewer.adp @@ -0,0 +1,40 @@ +<!DOCTYPE DCF> + +<assistantconfig version="3.2.0"> + +<profile> + <property name="name">simpletextviewer</property> + <property name="title">Simple Text Viewer</property> + <property name="applicationicon">images/handbook.png</property> + <property name="startpage">index.html</property> + <property name="aboutmenutext">About Simple Text Viewer</property> + <property name="abouturl">about.txt</property> + <property name="assistantdocs">.</property> +</profile> + +<DCF ref="index.html" icon="images/handbook.png" title="Simple Text Viewer"> + <section ref="./findfile.html" title="Find File"> + <keyword ref="./index.html">Display</keyword> + <keyword ref="./index.html">Rich text</keyword> + <keyword ref="./index.html">Plain text</keyword> + <keyword ref="./findfile.html">Find</keyword> + <keyword ref="./findfile.html">File menu</keyword> + <keyword ref="./filedialog.html">File name</keyword> + <keyword ref="./filedialog.html">File dialog</keyword> + <keyword ref="./wildcardmatching.html">File globbing</keyword> + <keyword ref="./wildcardmatching.html">Wildcard matching</keyword> + <keyword ref="./wildcardmatching.html">Wildcard syntax</keyword> + <keyword ref="./browse.html">Browse</keyword> + <keyword ref="./browse.html">Directory</keyword> + <keyword ref="./openfile.html">Open</keyword> + <keyword ref="./openfile.html">Select</keyword> + + <section ref="./filedialog.html" title="File Dialog" /> + <section ref="./wildcardmatching.html" title="Wildcard Matching" /> + <section ref="./browse.html" title="Browse" /> + </section> + <section ref="./openfile.html" title="Open File" /> +</DCF> + +</assistantconfig> + diff --git a/examples/assistant/simpletextviewer/documentation/wildcardmatching.html b/examples/assistant/simpletextviewer/documentation/wildcardmatching.html new file mode 100644 index 0000000..eb1839a --- /dev/null +++ b/examples/assistant/simpletextviewer/documentation/wildcardmatching.html @@ -0,0 +1,57 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Wildcard Matching</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Wildcard Matching</h2></center></p> + + <p> + Most command shells such as bash or cmd.exe support "file + globbing", the ability to identify a group of files by using + wildcards. + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/wildcard.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + Wildcard matching provides four features: + </p> + + <ul> + <li>Any character represents itself apart from those + mentioned below. Thus 'c' matches the character 'c'. + </li> + <li>The '?' character matches any single character.</li> + <li>The '*' matches zero or more of any characters.</li> + <li>Sets of characters can be represented in square brackets. + Within the character class, like outside, backslash + has no special meaning. + </li> + </ul> + + <p> + For example we could identify HTML files with + <code>*.html</code>. This will match zero or more characters + followed by a dot followed by 'h', 't', 'm' and 'l'. + </p> + + <br /> + <br /> + <p> + See also: <a href="browse.html">Browse</a>, <a href="filedialog.html">File Dialog</a>, + <a href="findfile.html">Find File</a> + </p> + </body> +</html> + + + |
