Differences

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

--- mutil_import_files.bbs [2016/03/25 04:44] – [IMPORT_FILES.BBS Stanza Options] g00r00
+++ mutil_import_files.bbs [2023/01/03 01:58] (current) – IMPORT_FILES.BBS Stanza added desc_wrap avon
@@ Line 1: / Line 1: @@
-====== Importing FILES.BBS ======
+====== Import FILES.BBS ======
-MUTIL can import various formats of FILES.BBS into Mystic BBS using options configured in the supplied .INI file.
+MUTIL can import various formats of FILES.BBS into Mystic BBS using options configured in the supplied .INI file.  If can also synchronize the file size/descriptions of existing files often useful when using a 3rd party TIC processor.
 //For more information on the general usage of MUTIL see the [[mutil_howto|How to Use Mystic Utilities (MUTIL)]] section.//
-===== IMPORT_FILES.BBS Stanza Options =====
+===== IMPORT_FILES.BBS Stanza =====
-^ OPTION NAME ^ EXAMPLE             ^ DESCRIPTION ^
+^ OPTION NAME ^ DEFAULT / EXAMPLE     ^ DESCRIPTION ^
 | filesbbs    | filesbbs=files.bbs  | This option defines the filename of the files.bbs that the importer will look for.  If this option is not defined, "files.bbs" will be used automatically. |
 | uploader_name | uploader_name=Mystic BBS | This option defines the name used in the Uploader field in the database.  If this option is not defined, "Mystic BBS" will be used. |
-| update_files | update_files=false | If set to TRUE, the importer will compare the size of the file on disk with what is in the database.  If the filesize is different, it will be updated along with the description in the file database.  Enabling this option can add a significant amount of processing time to the import process. |
+| update_files | update_files=false | If set to TRUE, the importer will compare the size of the file on disk with what is in the database.  If the filesize is different, it will be updated along with the description in the file database.  Enabling this option can add a significant amount of processing time when working with very large file base listings. |
 | delete_after | delete_after=false | If set to TRUE, the importer will delete the files.bbs file after processing. |
-| desc_first | desc_first=0 | This option defines how the first line of the description is parsed.  If set to -1 then the importer will not look for the first line of the description on the line that has the filename.  If it is set to 0 then the importer will assume the description starts directly after the filename.  If set to anything else, the importer will go to the column and copy any text on and after it as use that as the first description line. |
+| desc_first | desc_first=0 | This option defines how the first line of the description is parsed.  If set to -1 then the importer will not look for the first line of the description on the line that has the filename.  If it is set to 0 then the importer will assume the description starts directly after the filename.  If set to anything else, the importer will go to the column and copy any text on and after it and use that as the first description line. |
-| desc_char | desc_char=| | This option defines the character that signifies an extended description line.  A blank value means a space character. |
+| desc_wrap | desc_wrap = true | If you are importing a files.bbs that has a filename and description on a single line Mystic will word wrap the description at 50 characters when enabled. |
+| desc_char | desc_char=%%|%% | This option defines the character that signifies an extended description line.  A blank value means a space character. |
 | desc_start | desc_start=3 | This option defines the column where the DESC_CHAR is found.  If the DESC_CHAR is found in this column, then all text afterwards will be imported as an extended description line. |
 ===== Example Configurations =====
-**NOTE:** In the examples configurations below, the only real notable options that need to be defined are the "DESC_FIRST" "DESC_START" and "DESC_CHAR" options.  Any other options are specific to functionality, not the format of the files.bbs file itself.
+The following section shows various FILES.BBS formats and their .INI configuration that was used to successfully import each format.  Only the "DESC_FIRST" "DESC_START" and "DESC_CHAR" options are significant to defining the format of the file, so other options are intentionally removed from the examples.
-==== Example Configuration #1 ====
+==== Format #1 (PCBoard, Others) ====
+This FILES.BBS format has a fixed description on the first line at column 34, and each description line is determined by a pipe character at column 32.  An example entry looks like this:
+<code>
+MYFILE.ZIP     511579  01-17-96  This is an example description line
+                               | This is another one
+                               | And so is this
+</code>
+The minimal .ini file for MUTIL would be configured like so:
+<code>
+[General]
+  Import_FILES.BBS = true
+[Import_FILES.BBS]
+  desc_first    = 34
+  desc_char     = |
+  desc_start    = 32
+</code>
+==== Format #2 (?) ====
+This FILES.BBS format has the first line of the description directly after the file name without a fixed character position.  Each extended description line is fixed at column 14, so we configure a space character on column 13 to trigger an extended description.  Any example entry looks like this:
+<code>
+MYFILE.ZIP   This is an example description line <ASP>
+             This is another one
+             And so is this
+</code>
+The minimal .ini file for MUTIL would be configured like so:
+<code>
+[General]
+  Import_FILES.BBS = true
+[Import_FILES.BBS]
+  desc_first    = 0
+  desc_char     =
+  desc_start    = 13
+</code>
+==== Format #3 (GT Power, Others) ====
 This FILES.BBS format has no description on the first line and each description line is determined by a pipe character at column 3.  An example entry looks like this:
 <code>
-TEST1.ZIP     511579  01-17-96
+MYFILE.ZIP     511579  01-17-96
   | This is a test file description
   | And this is the second line
 </code>
-The INI [Import_FILES.BBS] stanza for MUTIL would be configured like so:
+The minimal .ini file for MUTIL would be configured like so:
 <code>
-filesbbs      = files.bbs
+[General]
-uploader_name = Mystic BBS
+  Import_FILES.BBS = true
-update_files  = false
+[Import_FILES.BBS]
-desc_first    = -1
+  desc_first    = -1
-desc_char     = |
+  desc_char     = |
-desc_start    = 3
+  desc_start    = 3
-delete_after  = false
 </code>