Differences

This shows you the differences between two versions of the page.

--- menu_commands [2018/04/01 16:29] – g00r00
+++ menu_commands [2018/04/05 10:31] – [GENERAL COMMANDS] g00r00
@@ Line 291: / Line 291: @@
                     Data: c:\mystic\textfile\myfile
-                  Result: Mystic will display the ANSI version if it exists or the ASCII
+                  Result: Mystic will display the ANSI version if it exists or the
-                          version if it does not.
+                          ASCII version if it does not. (.ans and .asc respectively)
                     Data: bbsnews /NEW
@@ Line 313: / Line 313: @@
                           only if it was updated since the user's last login.
+**GV - View a display file in ANSI viewer**
+         Data: <template>;<helpfile>;<speed>;<filename>[;END]
+  Description: The ANSI viewer shows a file within the full screen, allowing the user to
+               scroll up and down through the file using their arrow keys, page up/down,
+               and home keys.  The viewer also has the ability to extract and display
+               SAUCE tags to get the artist and group information.  Pressing SPACE will
+               also display the file in a "traditional" BBS way, scrolling from start to
+               finish using the supplied emulated baud rate.  Several values are required
+               in the DATA field for this command, separated by a semi-colon:
+               <template> defines the template used for the viewer itself, found in the
+               current theme's display (text) directory.  For more information on
+               configuration of the template, see **TO BE COMPLETED** section.
+               <helpfile> defines the help file displayed when the user selects to show
+               help from within the viewer.  It should be in the text directory.
+               <speed> defines the baud rate to emulate when displaying the file if the
+               user selects <space> to display traditionally.  Use a baud rate of 0 for
+               a full speed display.
+               <filename> defines the name of the file to actually display to the user.
+               If no file extension is provided, ".ans" will be assumed.  If no path
+               is provided, Mystic will use the current theme's text directory.
+               Optional paramenters:
+               <END> if ";END" is added after the filename field, the viewer will start
+               viewing at the end of the file instead of the beginning.
+               Examples:
+                  Command: GV
+                     Data: ansigalv;ansigalh;38400;myansifile
+                  Command: GV
+                     Data: ansigalv;ansigal;0;myansifile;END
+               The first example will execute the display file viewer using the
+               template "ansigalv" and the help file "ansigalh" with the baud rate
+               of 38400 if a user presses <space> to do a traditional view.  The
+               file "myansifile" is the display file, since it is missing a path
+               and a file extension, Mystic will use ".ans" and the current theme
+               text directory.
+               The second example is the same as the first, except it displays the
+               file at full speed instead of 38400 baud emulation, and also starts
+               showing the file at the end of the file, rather than the beginning.
 ----
 ===== INTERNET RELATED =====