--- © TNE ManualServer Configuration File ### This config should work with all systems. ### Integrate your specific entries here! (not case sensitive) ### Do not edit entries beginning with *** ### Do not use TABs (Tabulators) in config-lines! ### more important Info: see below @@@ End of Manual.config ***** Document Suffixes ---(max. 24)------------------------------ (1st section) ### Determining the corresponding MARInA-Viewer by suffix: ### The first Entry will ensure, that Files with a Suffix ".guide" ### will be started by the MARInA_Viewer, which is called by ${RefTable/ViewGuide} GUIDE ${RefTable/Text-ViewGuide} DOC ${RefTable/Text-ViewASCII} DOK ${RefTable/Text-ViewASCII} DVI ${RefTable/Text-ViewDVI} PDF ${RefTable/Text-ViewPDF} ### X-Manpages 0 ${RefTable/MultiView} MAN ${RefTable/Text-ViewASCII} ### local ManualServer document-links LOC SYS:C/Execute ### As entered below, every Section must end up with an @ @ End of declaration for Document Suffix related Viewers. ***** MainPathSearch ---(max. 32)-------------------------------- (2nd section) ### First entry: searched first, last entry: searched last. ### Supply the "Help-Scan" Directories where your Documents should be searched. ### Keep the first two entries . and HELP: unmodified! ### They are supplied for ManualServing mode: . #single point: let search in the File's original directory first... ; #as here, every entry must end up with a semicolon at leftmost line position. ***** BreakIfFound: Will break Search if an appropriate Document was found above ; (must also be terminated with a semicolon at the leftmost line-position) HELP: #ManualServing mode only ; ### For determining of supplied manuals' path-characteristics to ### -> their corresponding destination help-directories: ### (Do not comment lines beginning with -> ) ### Documents containing MUI: or MUI/ (Identifiers) in their path will be ### stored in the specific Doc-Storage -> SYS:MUI/Docs/ split up into language folders. ### Your preferred languages are known from ENV:sys/locale.prefs -> SYS:MUI/Docs/ MUI: #Maximum 16 Identifiers per Doc-Storage-Path. MUI/ #Pathes must end with / or : ; #simply list all characterstics that identify MUI-related stuff upto this line ### move all devices' manuals to SYS:devs/Help/ without language Folders (NOFOLDERS) -> SYS:devs/Help/ NOFOLDERS .device devs/ ; #simply list all characterstics that identify devs-related stuff úpto this line -> SYS:Classes/Help/ NOFOLDERS .datatype Classes/ datatypes/ ; ### Here, additionally a commandline will be started with arguments ### when using the Manual-serving mode (commented example): ### -> Developer:libs/Help/ NOFOLDERS execute sys:libs/Help/LibGuide.script ### Developer:libs/ ### ; -> SYS:libs/Help/ NOFOLDERS .library libs/ ; -> SYS:l/Help/ NOFOLDERS -handler :l/ ; ***** BreakIfFound ; ### Add your own partitions here (examples commented by "### "): ### More Directories on all Partitions, that you want to have own hosted ### Help-Subdirectories. To let create them, just drop the Manual-Icons ### out of one of these Folders onto the Manual-Dock (after having ### configured this section, respectively) one after the other... ### -> Work:Help/ ### Work: ### ; ### -> Developer:SC/Help/ NOFOLDERS ### Developer:SC/ ### DH2:SC/ ### SC: ### ; ### -> Developer:Help/ ### Developer: ### ; ***** BreakIfFound ; ### Keep those entries unchanged! and as last entry of MainPathSearch: ### but add your System-partition's Name here (e.g. WBench: ) ### and add your System-partition's device name here (e.g. DH0: ) -> Help: SYS: WB: WB3.1: WB3.0: WB2.1: WB2.0: Workbench: System: DH0: ; @ End of MainPath Document Search Directories ***** Various Directories ------------------------------------------ (last section) ### Best supply all directories of system-binaries, here for extended Document search. ### be aware that you will be requested for unmounted volumes in the entries! SYS:c/ SYS:MARInA_bin/ SYS:Prefs/ SYS:Utilities/ SYS:System/ SYS:Tools/ SYS:Tools/Commodities/ SYS:Commodities/ devs:monitors/ devs:printers/ devs:datatypes/ s: l: libs: devs: @ End of Various Directories Searchpath @@@ End of Manual.config (reading the config ends here) __________________________________________________________________ MARInA System © TNE) 1997/98 All Manuals must have a name that consists of the Tool's or Library's or device's or ...) original name and a suffix which may be defined below (usually DOC, MAN, GUIDE, ...). Thus, for example a manual for ToolManager must be named ToolManager.guide e.g. Or each manual for diskfont.library must be named diskfont.library.doc (or diskfont.library.guide) ... Different languages' Documents will be devided up into language-Subdirs. Do not store language extensions to the FileName! See below. Most Suffixes have been predefined for you. Do not use system-specific pathes for the viewers! Use MARInA-References as shown: ${RefTable/...} Adding Comments to Manual.config, user-Comments may be entered by: ### (leftmost line position) Do not place any Environment Vars inside Various Directories section! Usage: Dropping files onto the ManualServer Dock (or giving arguments to 'man') will result in three ways of reaction: Document files will be taken and archived to the preconfigured directories which are represented as -> SYS:Locale/Help/ entries, to give an example. (for Manual archiving mode) Programm files will be taken and related docs will be viewn if existent in the given Directories (manual serving mode). When called without arguments, the ManualServer will present a GUI for entering the searched term. From here, you may as well call the Manual.config editor. Getting Help: So, if you should search information for jfif.datatype, just drop the jfif.datatype WB-Icon upon the ToolManager MARInA-ManualServer Dock, or type in a shell: man jfif.datatype (the manual-server will then scan through all parametrized directories for an appropriate doc, guide, pdf or whatever you entered in the suffix section) Remember: Documents must have the same name as the searched term plus the Document suffix, such as: jfif.datatype.guide Providing Documents (after standard-installation of apps): Be sure to have supplied Directories to the MainPath Section, where the different kinds of Documents should be stored (scan-directories and related identifiers which will be compared to the path of the dropped document-icons ) If you want to have a recently unpacked document installed to it's appropriate directory, just move it on with it's program to the Program's directory, then take it and drop the document file (must have Program's name + Suffix) upon the ToolManager Manual button. A self explaining dialog will be started. Local installation for documents means that it will stay within the program's original directory, whereas a link-File (getting a .loc suffix for "location") will be created in the appropriate center help scan-directory which will be scanned in search-mode. Center installation for documents means, that the document will be moved to the declared scan-directory and will not reside at it's program location. The document's icon, if existent, will be discarded in this case, because it will not be needed any more. The ManualServer provides the appropriate user-interface for calling it easily now. An example for extending online-Help by Scripts (to be entered inside section MainPath-Search): -> SYS:Classes/help/ NOFOLDERS execute SearchScript datatypes/ .datatype ; ### Documents for Files containing datatype/ or .datatype ### in their path (including the name) will be scanned and ### stored in SYS:Classes/Docs/ without language folders (NOFOLDERS). ### After scanning for the manual, an individual commandline will be ### started, if word three and four of the Path-line provides it. ### The Pathline must begin with -> if Identifiers are entered ### in the following lines (here: datatypes/ and .datatype). ### The SearchScript will be handed over two Arguments: ### as Arg1: The Searched Term ### as Arg2: SYS:Classes/help (the path entered after -> )