# HG changeset patch # User smith@nwoca.org # Date 1296010771 18000 # Node ID 22ed6d93442ce6feeb4e2e25bc4aea1916e8f096 # Parent 4417b025157ebbffac094848af9e308bcded8fca Start modifying transformers to Confluence wiki syntax diff -r 4417b025157e -r 22ed6d93442c src/org/nwoca/ssdt/tools/html2wiki/ChapterTransformer.java --- a/src/org/nwoca/ssdt/tools/html2wiki/ChapterTransformer.java Tue Jan 25 17:08:12 2011 -0500 +++ b/src/org/nwoca/ssdt/tools/html2wiki/ChapterTransformer.java Tue Jan 25 21:59:31 2011 -0500 @@ -18,8 +18,7 @@ boolean first = true; while (matcher.find( 0 )) { buffer.replace(matcher.start(),matcher.end(), - "" + matcher.group(1) +"\n__TOC__" + - (category == null ? "" : "\n[[Category:" + category + "]]")); + "" + matcher.group(1) + "\n{panel}{toc}{panel}"); first = false; } diff -r 4417b025157e -r 22ed6d93442c src/org/nwoca/ssdt/tools/html2wiki/Html2Wiki.java --- a/src/org/nwoca/ssdt/tools/html2wiki/Html2Wiki.java Tue Jan 25 17:08:12 2011 -0500 +++ b/src/org/nwoca/ssdt/tools/html2wiki/Html2Wiki.java Tue Jan 25 21:59:31 2011 -0500 @@ -36,32 +36,47 @@ public Html2Wiki(String html) { buffer = new StringBuffer(html); transformers = new ArrayList(); - transformers.add(new PreTagTransformer()); - transformers.add(new DeleteTransformer("^\\s",true)); +// transformers.add(new PreTagTransformer()); +// transformers.add(new DeleteTransformer("^\\s",true)); transformers.add(new DeleteTransformer("|||")); transformers.add(new DeleteTransformer("(\\n|\\r)*",true)); transformers.add(new DeleteTransformer("|")); transformers.add(new DeleteTransformer("(?m)^\\*")); - transformers.add(new DeleteTransformer("
|
")); +// transformers.add(new DeleteTransformer("
|
")); transformers.add(new DeleteTransformer("

")); transformers.add(new DeleteTransformer("(?m)
$")); transformers.add(new DeleteTransformer("|")); - transformers.add(new CloseTagTransformer("

  • ","(\n|\r)*(
  • |||||","{ul}")); + transformers.add(new ReplaceTransformer("
  • ","{li}")); + transformers.add(new ReplaceTransformer("
  • ","{li}\n")); transformers.add(new ChapterTransformer(category)); - transformers.add(new TagTransformer("(.*?)", "''")); - transformers.add(new TagTransformer("(.*?)", "'''")); - transformers.add(new TagTransformer("(?s)(.*?)", "", "")); - transformers.add(new TagTransformer("

    (.*)

    ", "== ", " ==")); - transformers.add(new TagTransformer("

    (.*)

    ", "=== ", " ===")); - transformers.add(new TagTransformer("

    (accessing the program|sample run|sample screens?|sample reports?)","=== ", " ===")); - transformers.add(new TagTransformer("

    (.*)

    ", "", "")); - transformers.add(new TagTransformer("

    (.*)

    ", "==== ", " ====")); - transformers.add(new TagTransformer("

    (.*)

    ", "===== ", " =====")); - transformers.add(new TagTransformer("
    (.*)
    ", "====== ", " ======")); - transformers.add(new TagTransformer("
    (.*)
    ", "======= ", " =======")); + transformers.add(new TagTransformer("
    (.*?)
    ", true, "{code}","{code}")); + transformers.add(new TagTransformer("
    (.*?)
    ", true, "{center}","{center}")); + transformers.add(new TagTransformer("(.*?)", "*","*")); + transformers.add(new TagTransformer("(.*?)", "*","*")); + transformers.add(new TagTransformer("(?s)(.*?)", "{{", "}}")); + transformers.add(new TagTransformer("

    (.*)

    ", "h1. ", "")); + transformers.add(new TagTransformer("

    (.*)

    ", "h2. ", "")); + transformers.add(new TagTransformer("

    (accessing the program|sample run|sample screens?|sample reports?)","h3.", "")); + transformers.add(new TagTransformer("

    (.*)

    ", "h3. ", "")); + transformers.add(new TagTransformer("

    (.*)

    ", "h3. ", "")); + transformers.add(new TagTransformer("

    (.*)

    ", "h4. ", "")); + transformers.add(new TagTransformer("
    (.*)
    ", "h5. ", "")); + transformers.add(new TagTransformer("
    (.*)
    ", "h6. ", "")); transformers.add(new DeleteTransformer("(?s)")); } @@ -123,7 +138,7 @@ } public static String generateFilename(String input) { - return input.replaceAll("\\\\|/|:|\\(|\\)","-"); + return input.replaceAll("\\\\|/|:|\\(|\\)","-").replace("
    ", ""); } public String getWikiText() { diff -r 4417b025157e -r 22ed6d93442c src/org/nwoca/ssdt/tools/html2wiki/ReplaceTransformer.java --- a/src/org/nwoca/ssdt/tools/html2wiki/ReplaceTransformer.java Tue Jan 25 17:08:12 2011 -0500 +++ b/src/org/nwoca/ssdt/tools/html2wiki/ReplaceTransformer.java Tue Jan 25 21:59:31 2011 -0500 @@ -16,11 +16,10 @@ Matcher matcher = replace.matcher(buffer); boolean first = true; - while (matcher.find(first ? 0 : matcher.end())) { + while (matcher.find(first ? 0 : matcher.start() + replacement.length())) { buffer.replace(matcher.start(),matcher.end(),replacement); first = false; - } - + } } public String toString() { diff -r 4417b025157e -r 22ed6d93442c src/org/nwoca/ssdt/tools/html2wiki/TagTransformer.java --- a/src/org/nwoca/ssdt/tools/html2wiki/TagTransformer.java Tue Jan 25 17:08:12 2011 -0500 +++ b/src/org/nwoca/ssdt/tools/html2wiki/TagTransformer.java Tue Jan 25 21:59:31 2011 -0500 @@ -3,33 +3,41 @@ import java.util.regex.*; class TagTransformer implements Transformer { + private Pattern tagPattern; private String replacementBegin; private String replacementEnd; - + public TagTransformer(String regexp, String replacementBegin, String replacementEnd) { - tagPattern = Pattern.compile(regexp); + this(regexp, false, replacementBegin, replacementEnd); + } + + public TagTransformer(String regexp, boolean multiline, String replacementBegin, String replacementEnd) { + tagPattern = multiline + ? Pattern.compile(regexp, Pattern.MULTILINE + Pattern.DOTALL) + : Pattern.compile(regexp); + this.replacementBegin = replacementBegin; this.replacementEnd = replacementEnd; - + } + public TagTransformer(String regexp, String replacement) { - this(regexp,replacement,replacement); + this(regexp, replacement, replacement); } - + public void apply(StringBuffer buffer) { Matcher matcher = tagPattern.matcher(buffer); - + boolean first = true; while (matcher.find(first ? 0 : matcher.start())) { - buffer.replace(matcher.start(),matcher.end(),replacementBegin + matcher.group(1) + replacementEnd); + buffer.replace(matcher.start(), matcher.end(), replacementBegin + matcher.group(1) + replacementEnd); first = false; } - - } - - public String toString() { - return "Replace: " + tagPattern.pattern() + " with " +replacementBegin + "..." + replacementEnd; + } -} \ No newline at end of file + public String toString() { + return "Replace: " + tagPattern.pattern() + " with " + replacementBegin + "..." + replacementEnd; + } +} diff -r 4417b025157e -r 22ed6d93442c test/org/nwoca/ssdt/tools/html2wiki/Html2WikiTest.java --- a/test/org/nwoca/ssdt/tools/html2wiki/Html2WikiTest.java Tue Jan 25 17:08:12 2011 -0500 +++ b/test/org/nwoca/ssdt/tools/html2wiki/Html2WikiTest.java Tue Jan 25 21:59:31 2011 -0500 @@ -36,29 +36,29 @@ return suite; } - public void testChapterParsing() throws Exception { - - File f = new File(path, "sysman_handbook.html"); - - Html2Wiki converter = new Html2Wiki(FileUtils.readFileToString(f, null)); - - Html2Wiki.WikiChapter[] chapters = converter.getWikiChapters(); - - assertTrue( chapters.length > 0); - for (Html2Wiki.WikiChapter c : chapters) { - System.out.println(c); - } - } +// public void testChapterParsing() throws Exception { +// +// File f = new File(path, "sysman_handbook.html"); +// +// Html2Wiki converter = new Html2Wiki(FileUtils.readFileToString(f, null)); +// +// Html2Wiki.WikiChapter[] chapters = converter.getWikiChapters(); +// +// assertTrue( chapters.length > 0); +// for (Html2Wiki.WikiChapter c : chapters) { +// System.out.println(c); +// } +// } /** * Test of main method, of class org.nwoca.ssdt.tools.html2wiki.Html2Wiki. // */ -// public void testMain() throws Exception { + public void testMain() throws Exception { // System.out.println("main"); // // File path = new File(Html2WikiTest.class.getResource("/resources").toURI()); // System.out.println(path); -// Html2Wiki.main(new String[]{path.toString(), "OECN System Managers Handbook"}); + Html2Wiki.main( new String[] {path.toString(), "OECN System Managers Handbook"}); // -// } + } } diff -r 4417b025157e -r 22ed6d93442c test/resources/sysman_handbook.html --- a/test/resources/sysman_handbook.html Tue Jan 25 17:08:12 2011 -0500 +++ b/test/resources/sysman_handbook.html Tue Jan 25 21:59:31 2011 -0500 @@ -1,7 +1,7 @@ - + @@ -68,7 +68,7 @@


    -

    Chapter 1
    Introduction

    +

    Introduction

    The OECN Menu processor provides a flexible user menu interface to @@ -77,7 +77,7 @@ for all state software programs. Individual A-sites will be able to add customized menus to the default menu system provided. -

    1.1 Features

    +

    Features

    The Menu processor provides the following features: @@ -118,7 +118,7 @@


    -

    Chapter 2
    Theory

    +

    Theory

    The basic theory behind the Menu processor is fairly simple. The menu @@ -126,14 +126,14 @@ flexible enough to allow creation of menus containing any combination of DCL commands, programs and information. -

    2.1 Definition of Terms

    +

    Definition of Terms

    First, it will be helpful to define some terms that will be used throughout the rest of this document.

    - + @@ -222,14 +222,14 @@
    Table 2-1 Menu System Terms Menu System Terms
    Term Meaning
    -

    2.2 How Menu Files Create a Menu System

    +

    How Menu Files Create a Menu System

    Figure 2-1 displays a graphical representation of a possible menu system.

    -Figure 2-1 Conceptual View of a Menu system +Conceptual View of a Menu system


    @@ -291,7 +291,7 @@ for VAX/VMS System Manager manual for more information about security and the OSA utility. -

    2.3 Menu Specifications

    +

    Menu Specifications

    Throughout this document there are references to menu @@ -383,7 +383,7 @@ -

    2.4 The Alias File

    +

    The Alias File

    Each menu system may have exactly one alias file. An @@ -402,7 +402,7 @@ The alias file is built automatically by the MENUUTL program. See Section 5.2.1, Building the Alias File for more information about creating the alias file. -

    2.5 Option execution

    +

    Option execution

    By default, the menu processor does not spawn subprocesses to @@ -413,7 +413,7 @@ optimal response time for smaller VAX processors, particularly machines with small memory configurations. -

    2.5.1 Spawning Options

    +

    Spawning Options

    Another mode that may be chosen by the system manager is "spawn and @@ -467,7 +467,7 @@ SSDT that need the "DP" item type was the DETPRT option of the LOCAL menu. All other SSDT menu items may be executed in a subprocess. -

    2.5.2 Selecting Execution Mode

    +

    Selecting Execution Mode

    To select either "terminate and execute" or "spawn and execute" mode, @@ -490,7 +490,7 @@ This logical also can be defined at the group or process level. If the logical is not defined, the default is "TERMINATE". -

    2.6 Inactivity Timeout

    +

    Inactivity Timeout

    The menu processor has an optional feature that will cause it to @@ -533,7 +533,7 @@


    -

    Chapter 3
    Implementation

    +

    Implementation

    Several steps are required in order to implement the Menu Processor on @@ -551,7 +551,7 @@ shared image. -

    3.1 Installation

    +

    Installation

    The Menu Processor uses files from the OECN, MENU and HELP packages. @@ -559,14 +559,14 @@ information about OECN_INSTALL see OECN_INSTALL.DOC in the VAX manager documentation directory. -

    3.2 Establish OECN Logicals

    +

    Establish OECN Logicals

    Several logicals are used by the Menu Processor to locate the menu files and VMS Help libraries.

    - + @@ -670,7 +670,7 @@ system, group or process level. For example, the OECN$MENU logical may be defined for each user to provide a different default menu. -

    3.2.1 Specifying options with OECN$MENU_BEHAVIOR logical

    +

    Specifying options with OECN$MENU_BEHAVIOR logical

    This section describes the commands that may be placed in the @@ -694,7 +694,7 @@

    Table 3-1 Menu Logicals Menu Logicals
    Logical Purpose
    - + @@ -749,7 +749,7 @@
    Table 3-2 Behavior Options Behavior Options
    Command Description
    -

    3.3 Move Files to Appropriate Directories

    +

    Move Files to Appropriate Directories

    Move the menu files (OECN$ROOT:[MENU.DIST]*.DAT) to the directory @@ -774,7 +774,7 @@

    The users must have execute access to these files. -

    3.4 Add Global Symbol

    +

    Add Global Symbol

    Add the following symbol to either your SYLOGIN.COM or each user's @@ -796,7 +796,7 @@ easier for your users to invoke a menu. These symbols will be discussed in the Chapter 4, Invoking the Menu Processor. The OECN_MENU symbol is the only required symbol. -

    3.5 Install the Menu Processor

    +

    Install the Menu Processor

    Although it is not necessary for proper execution of the Menu @@ -826,7 +826,7 @@


    -

    Chapter 4
    Invoking the Menu Processor

    +

    Invoking the Menu Processor

    The Menu Processor must be invoked via a command procedure that is @@ -904,7 +904,7 @@ login procedure or from inside another procedure. No restrictions are placed on the method of invoking the Menu Processor. -

    4.1 Examples

    +

    Examples

    For most users the following symbol definition is sufficient: @@ -965,7 +965,7 @@


    -

    Chapter 5
    Modifying and Creating Menu Systems

    +

    Modifying and Creating Menu Systems

    The MENUEDT program is a fully functional maintenance program for @@ -974,7 +974,7 @@ such as building the alias file and reporting functions.

    - + @@ -1020,7 +1020,7 @@ menus that you modify or create should be tested thoroughly before being made available to your users. -

    5.1 Using MENUEDT

    +

    Using MENUEDT

    When you first run the MENUEDT program it will prompt you for the name @@ -1028,7 +1028,7 @@ created.

    Table 5-1 Menu Record Types Menu Record Types
    Record Type Function
    - + @@ -1109,14 +1109,14 @@
    Table 5-2 MENUEDT Main Menu Options MENUEDT Main Menu Options
    Option Function
    -

    5.1.1 Menu File Record Types

    +

    Menu File Record Types

    This section and the following sections show sample screens that are used by MENUEDT to modify the various record types. After each screen is a detailed explanation of each field and its purpose. -

    5.1.2 File Header Record

    +

    File Header Record

    The first record in each menu file must be a File Header record and @@ -1141,7 +1141,7 @@

    - + @@ -1177,7 +1177,7 @@
    Table 5-3 File Header Record Fields File Header Record Fields
    Field Description
    -

    5.1.3 Menu Header Record

    +

    Menu Header Record

    The Menu Header record contains information about each menu in the @@ -1207,7 +1207,7 @@

    - + @@ -1296,7 +1296,7 @@
    Table 5-4 Menu Header Fields Menu Header Fields
    field Description
    -

    5.1.4 Menu Item Record

    +

    Menu Item Record

    One menu item record must be specified for each desired item on a menu. @@ -1312,7 +1312,7 @@

    - + @@ -1383,7 +1383,7 @@

    Table 5-5 Menu Item Types Menu Item Types
    Item Type Interpretation of Action Field
    - + @@ -1503,7 +1503,7 @@

    -

    5.1.4.1 Values for Action Field

    +

    Values for Action Field

    Much of the Menu Processor's flexibility is provided by the values that @@ -1633,7 +1633,7 @@ Description field is simply displayed on the menu without a label or an option number. -

    5.1.5 Menu Security Screen

    +

    Menu Security Screen

    The Modify Security Identifier screen allows you to @@ -1710,7 +1710,7 @@ Up to 16 identifier positions have been reserved for use at the A-site level. See OECN_IDS.LIB in OECN$LIB: for instructions. -

    5.1.5.1 Security Identifiers

    +

    Security Identifiers

    The security identifiers that appear on the Security Identifier screen @@ -1724,7 +1724,7 @@ level access to the highest.

    Table 5-6 Menu Item Fields Menu Item Fields
    Field Description
    - + @@ -1792,7 +1792,7 @@ A-site specific identifiers. That is, there will also be OECN_USER1_RO and OECN_USER1_GM identifiers available for use at the A-site level. -

    5.2 Using MENUUTL

    +

    Using MENUUTL

    The MENUUTL program provides some necessary functions for building, @@ -1805,7 +1805,7 @@

  • Hierarchical Menu Listing -

    5.2.1 Building the Alias File

    +

    Building the Alias File

    The first and the most important option of MENUUTL is the alias file @@ -1916,7 +1916,7 @@

  • Table 5-7 Security Access Levels Security Access Levels
    Access Level Suffix
    -

    5.2.2 Simulated Menu Listing

    +

    Simulated Menu Listing

    This option will read through the specified menu file and create a @@ -1925,14 +1925,14 @@ only report on one menu file at a time and will be sorted in alphabetical order by menu name. -

    5.2.3 Detailed Menu Listing

    +

    Detailed Menu Listing

    The detailed menu report lists all available information about the specified menu file. This report is particularly useful for double checking the action fields and security. -

    5.2.4 Hierarchical Listing

    +

    Hierarchical Listing

    This report will display the structure of the menu system. The menus @@ -1941,7 +1941,7 @@ to start. You need not necessarily start at the top of the entire menu system. -

    5.3 OSA

    +

    OSA

    The OSA, OECN Security Authorization, Utility may be used in @@ -1953,7 +1953,7 @@


    -

    Chapter 6
    Customizing Menus from the Distribution

    +

    Customizing Menus from the Distribution

    This chapter describes the recommended procedure for customizing the @@ -1991,7 +1991,7 @@ -

    6.1 Modifying a Local Menu File

    +

    Modifying a Local Menu File

    Following is the recommend procedure for modifying one or more menu @@ -2004,7 +2004,7 @@

  • Redefine OECN$MENU$FILES permanently -

    6.1.1 Redefine the OECN$MENU$FILES logical

    +

    Redefine the OECN$MENU$FILES logical

    The first step is to redefine OECN$MENU$FILES as a search list. For @@ -2041,7 +2041,7 @@ -

    6.1.2 Modify the Menu Files

    +

    Modify the Menu Files

    Copy the *_LCL.DAT menu files that you want to modify from the @@ -2055,7 +2055,7 @@ you're creating new menus, be sure that the users have read access to the new files. -

    6.1.3 Build a New Alias File

    +

    Build a New Alias File

    After all desired changes have been made, use MENUUTL to rebuild the @@ -2067,7 +2067,7 @@ You may build the alias file manually by running MENUUTL, or you may use the BUILD_ALIAS.COM procedure in the OECN$ directory. -

    6.1.4 Redefine OECN$MENU$FILES Permanently

    +

    Redefine OECN$MENU$FILES Permanently

    If you have not already done so, define the logical OECN$MENU$FILES to @@ -2076,7 +2076,7 @@

    At this point your users should have access to the customized menus. -

    6.2 After a Distribution

    +

    After a Distribution

    If you modify the local menu files in this way, your changes will not @@ -2115,7 +2115,7 @@ files. See the comments in BUILD_ALIAS.COM for more information about using this procedure. -

    6.3 Intercepting Menu Actions

    +

    Intercepting Menu Actions

    Sometimes it is desirable, or necessary, to redefine the action @@ -2244,9 +2244,9 @@


    -

    Chapter 7
    Batch Mail Message System Manager Guide

    - -

    7.1 Overview

    +

    Batch Mail Message System Manager Guide

    + +

    Overview

    The command procedure BATCH_MAIL_MESSAGE.COM can be used to send a VMS @@ -2254,7 +2254,7 @@ audiences where the user does not wish to tie up their terminal for an extended period of time. -

    7.2 Sending a Mail Message via Batch

    +

    Sending a Mail Message via Batch

    To use the command procedure for generic mail messages: @@ -2291,9 +2291,9 @@


    -

    Chapter 8
    OECN VIEW Utility

    - -

    8.1 Overview

    +

    OECN VIEW Utility

    + +

    Overview

    The OECN_VIEW utility allows users to view text files on the screen. It @@ -2320,7 +2320,7 @@

    Examples of the logicals are given below: -

    8.2 OECN_VIEW.COM

    +

    OECN_VIEW.COM

    The OECN_VIEW.COM command procedure is found in OECN$. It is used to @@ -2362,7 +2362,7 @@ -

    8.2.1 Customizing OECN VIEW

    +

    Customizing OECN VIEW

    The following sample command file shows how to customize the @@ -2405,7 +2405,7 @@ -

    8.2.2 Creating a DCL Command

    +

    Creating a DCL Command

    The VIEW utility works automatically from the MENU. However, you could @@ -2429,7 +2429,7 @@

    Then use the LOOK command from the $ prompt. -

    8.2.3 OECN_EDIT

    +

    OECN_EDIT

    The OECN_VIEW utility uses a special editor called OECN_EDIT. Its @@ -2439,9 +2439,9 @@


    -

    Chapter 9
    OECN EDIT Utility

    - -

    9.1 Overview

    +

    OECN EDIT Utility

    + +

    Overview

    OECN_EDIT is a foreign command replacement for the EDIT/TPU DCL @@ -2456,7 +2456,7 @@ VFC files to be viewed correctly. However, it may also be used with any TPU section file as an editor. -

    9.2 Using OECN_EDIT

    +

    Using OECN_EDIT

    In order to use OECN_EDIT as your interface to TPU, define the @@ -2484,9 +2484,9 @@


    -

    Chapter 10
    OECN KEYMAP Utility

    - -

    10.1 Overview

    +

    OECN KEYMAP Utility

    + +

    Overview

    The OECN_KEYMAP utility allows users to select a terminal emulator, @@ -2499,7 +2499,7 @@ to any PC key you wish in the emulator and then relabel F11 on the screen to match the PC keyboard. -

    10.2 Using KEYMAP

    +

    Using KEYMAP

    Upon selecting the KEYMAP option from the OECN menu the user is given a @@ -2551,9 +2551,9 @@


    -

    Chapter 11
    OECN SETUPENV Utility

    - -

    11.1 Overview

    +

    OECN SETUPENV Utility

    + +

    Overview

    SETUPENV is a general purpose utility for establishing or switching to @@ -2589,7 +2589,7 @@ by DA Sites, including group tables and shared logical tables. -

    11.2 Getting Started

    +

    Getting Started

    The SETUPENV utility is very flexible allowing the capability to deal @@ -2606,7 +2606,7 @@ Starting small will give the opportunity to experiment with the utility to see how, or if, it can fit into your environment. -

    11.2.1 Entity Types

    +

    Entity Types

    SETUPENV manages a user's context by assuming that any given process @@ -2639,7 +2639,7 @@ attribute for more information.

    -

    11.2.2 DCL Command Syntax

    +

    DCL Command Syntax


    @@ -2853,7 +2853,7 @@ Likewise, when /EMIS is specified, EMIS_SELECT_EPILOGUE and EMIS_SWITCH_FY will be invoked after successfully selecting a database. -

    11.3 Logicals Created By SETUPENV

    +

    Logicals Created By SETUPENV

    After successfully selecting an entry, SETUPENV establishes a series of @@ -2933,7 +2933,7 @@ Any of the logicals that do not apply to an entry will not be defined (e.g. for a parent entry, the siblings logical will not be defined). -

    11.4 OECN$SETUP.INI

    +

    OECN$SETUP.INI

    The OECN$SETUP initialization file defines the environment for various @@ -3121,7 +3121,7 @@ -

    11.4.1 Special "Reset" Entries

    +

    Special "Reset" Entries

    Prior to setting any given entry, SETUPENV will attempt to process @@ -3171,7 +3171,7 @@ general, you should explicitly deassign any logicals in the reset section that are defined in any entry of the same type. -

    11.4.2 Sample OECN$SETUP File

    +

    Sample OECN$SETUP File

    Below is a very simple OECN$SETUP.INI file which defines entries for @@ -3229,7 +3229,7 @@ The special $RESET_DISTRICT section is provided to ensure that the district logical get reset appropriately prior to setting an entry. -

    11.4.3 Special "APPLICATION" Entries

    +

    Special "APPLICATION" Entries

    If an entry is defined with one or more APPLICATION attributes, then @@ -3287,7 +3287,7 @@ Logicals defined in this manner may need to be included in the appropriate "$RESET_type" section to ensure they are reset. -

    11.4.4 Special "INCLUDE" Section

    +

    Special "INCLUDE" Section

    A special section may be specified in any INI file called $INCLUDE. @@ -3351,14 +3351,14 @@ immediately after). In general, you should not depend on files being processed in any particular order. -

    11.4.5 Limits

    +

    Limits

    Certain limits which apply to the OECN$SETUP.INI file are shown in the table below. Limits are 'per entry' unless otherwise noted.

    - + @@ -3577,7 +3577,7 @@
    Table 11-1 wide wide
    Attribute Maximum Length
    -

    11.5 EMIS_SELECT Compatibility

    +

    EMIS_SELECT Compatibility

    The /EMIS qualifier provides functional compatibility with the @@ -3657,7 +3657,7 @@ -

    11.5.1 Converting OECN$EMIS_DBS to OECN$SETUP

    +

    Converting OECN$EMIS_DBS to OECN$SETUP

    It is possible to completely convert from using the OECN$EMIS_DBS file @@ -3696,7 +3696,7 @@ -

    11.6 NOACSC Compatiblity

    +

    NOACSC Compatiblity

    SETUPENV is similar to the USE, BUNNY, and FROG utilities provided by @@ -3731,7 +3731,7 @@ This should allow SETUPENV to be used without modifying any existing command procedures. -

    11.6.1 USE Compatibliity

    +

    USE Compatibliity

    If /USE is specified as the first qualifier to SETUPENV, then the @@ -3813,7 +3813,7 @@ -

    11.6.2 BUNNY Compatibility

    +

    BUNNY Compatibility

    If /BUNNY is specified as the first qualifier to SETUPENV, then the @@ -3926,7 +3926,7 @@ ARCHIVE attribute for the selected entry. -

    11.6.3 FROG Compatibility

    +

    FROG Compatibility

    If /FROG is specified as the first qualifier to SETUPENV, then the @@ -4028,11 +4028,11 @@

    -

    11.7 OECN$SETUPENV API

    +

    OECN$SETUPENV API

    SETUPENV provides a callable API which can be used by programs to select entries. The API parallels the qualifier functions and syntax. -

    11.7.1 Working Storage Field(s)

    +

    Working Storage Field(s)

    @@ -4100,7 +4100,7 @@

    -

    11.7.2 COBOL Call Arguments

    +

    COBOL Call Arguments

    @@ -4141,7 +4141,7 @@
    -

    11.7.3 Argument Descriptions:

    +

    Argument Descriptions:

    WS-FUNCTION (read) @@ -4267,7 +4267,7 @@
    -

    11.7.4 Return Status

    +

    Return Status

    OECN$SETUP returns one of the following conditions: @@ -4320,7 +4320,7 @@ -

    11.7.5 Description

    +

    Description

    The OECN$SETUPENV routine does basically everything that the SETUPENV @@ -4344,9 +4344,9 @@


    -

    Chapter 12
    Installing and Using UMP - User Mail Profile System

    - -

    12.1 Overview

    +

    Installing and Using UMP - User Mail Profile System

    + +

    Overview

    The UMP package provides a means for DA-sites to maintain user e-mail @@ -4356,7 +4356,7 @@ which permits an easy way to lookup an e-mail address for any user on the OECN network. -

    12.1.1 Feature List

    +

    Feature List

    UMP provides the following features: @@ -4392,7 +4392,7 @@ if they wish to update their user mail profile during login. -

    12.1.2 Web Attachments for OECN state-wide mail

    +

    Web Attachments for OECN state-wide mail

    A special feature of the OECN state-wide lists is the ability to @@ -4426,7 +4426,7 @@ encouraged not to switch existing users to web attachments without training or notification. -

    12.1.2.1 Enabling Web Attachments

    +

    Enabling Web Attachments

    Web attachments are only enabled for each DA Site upon request. If you @@ -4446,7 +4446,7 @@ yourself. Only the OECN listmaster can make the change that affects the OECN mail server. -

    12.1.3 Files

    +

    Files

    The following sections describe the files used and produced by the UMP @@ -4583,7 +4583,7 @@ -

    12.2 UMP Menu and Profile Screen

    +

    UMP Menu and Profile Screen

    The program may be executed by typing: @@ -4806,7 +4806,7 @@ -

    12.3 Startup Procedure

    +

    Startup Procedure

    Follow the steps below to install UMP on your system: @@ -4831,7 +4831,7 @@

    -

    12.4 Loading Initial Data

    +

    Loading Initial Data

    Load existing distribution lists. If using NM style distribution lists, then use:
    @@ -4861,7 +4861,7 @@ essentially "merges" the NM and PMDF lists. This might be useful if you are uncertain which of your lists is more correct. -

    12.5 Importing Other Lists

    +

    Importing Other Lists

    The IMPORT_NM_LISTS.COM and IMPORT_PMDF_LISTS.COM only import the @@ -4898,13 +4898,13 @@ using UMPIMPORT.EXE.

    -

    12.6 INI File Commands

    +

    INI File Commands

    The following INI commands are used in either the OECN$UMP_LOCAL.INI or the OECN$UMP_STANDARD.INI files. The following is a summary of these commands. See either of these files for more examples of their use.

    - + @@ -5390,7 +5390,7 @@

    -

    12.7 Export NM and PMDF Style Lists

    +

    Export NM and PMDF Style Lists

    A procedure called OECN$:EXPORT_LISTS.COM to is used to create the NM and PMDF style distribution lists and associated aliases. It is recommended that each DAS write a custom DCL procedure which invokes @@ -5510,7 +5510,7 @@ databases into PMDF_TABLE:. -

    12.7.1 Centralized Naming

    +

    Centralized Naming

    This section describes several ways in which UMP can be used to provide @@ -5520,7 +5520,7 @@ you are already familar with the basic concepts of centralized naming in PMDF. -

    12.7.1.1 Remote Mail Boxes

    +

    Remote Mail Boxes

    UMP can provide centralized naming for users who have "remote" @@ -5590,7 +5590,7 @@ the username or alias on the UMP profile (not the username in the mailbox field). -

    12.7.1.2 User Aliases

    +

    User Aliases

    UMP provides the ability to create a user-specific alias independent of @@ -5635,7 +5635,7 @@ are disabled by default. The DAS must take explicit action (see below) to implement this feature. -

    12.7.1.2.1 Implementing User Aliases

    +

    Implementing User Aliases

    The following steps must be performed in order to activate the user @@ -5653,7 +5653,7 @@ invokes EXPORT_LISTS.COM. -

    12.8 Distribution List Codes

    +

    Distribution List Codes

    Each distribution list code has a "type" prefix. The type value allows @@ -5836,7 +5836,7 @@ This will restrict all type 11 lists to users who are also subscribed to the standard DAS staff list. -

    12.9 Auto Conversion of Distribution List Codes (Optional)

    +

    Auto Conversion of Distribution List Codes (Optional)

    Because of the features provided by the distribution list types, it may @@ -5887,7 +5887,7 @@ old and new codes on file. In this case, you may run the UMPUPDATE program to force the conversion on all records. -

    12.10 Defining Local Distribution Lists

    +

    Defining Local Distribution Lists

    To define a local distribution list, you need to add several additional @@ -5981,7 +5981,7 @@ sublists. Also, mail addressed to the master list will be delivered to everyone on any of the sublists. -

    12.11 Profile Group Management

    +

    Profile Group Management

    UMP provides the ability to segregate profiles into management @@ -6080,7 +6080,7 @@ control which profiles are sent to the OECN White Pages, then the correct values must be provided to the group manager. -

    12.12 Export DIRECTORY DAEMON File (optional)

    +

    Export DIRECTORY DAEMON File (optional)

    You have the option of exporting to a DIRECTORY DAEMON database. @@ -6163,7 +6163,7 @@ See the PMDF System Adminstrators Guide for more information about the directory daemon, channels and pseudo-domains. -

    12.13 Submit UMP Data to OECN CSO Database

    +

    Submit UMP Data to OECN CSO Database

    The CSO nameserver is a public domain software system which allows a @@ -6231,7 +6231,7 @@ username@po.nwoca.org regardless of their real host. In this way, remote users will not learn the real host name (which may change). -

    12.14 Master List/Sub-list Handling

    +

    Master List/Sub-list Handling

    Starting with the 29-Aug-95 version of UMPEXPORT, the master lists are @@ -6289,7 +6289,7 @@

    Table 12-1 Table of INI File Commands Table of INI File Commands
      Command
    -

    12.15 UMPCHECK - Verifying UMP Profiles against SYSUAF (Optional)

    +

    UMPCHECK - Verifying UMP Profiles against SYSUAF (Optional)

    UMPCHECK is a utility which reads the UMP profiles and compares the @@ -6365,7 +6365,7 @@ are the current values of the SYS$NODE and SYS$CLUSTER_NODE logicals.

    -

    12.16 UMP_LOGIN - To Prompt Users to Enter Profiles During Login (Optional)

    +

    UMP_LOGIN - To Prompt Users to Enter Profiles During Login (Optional)

    UMP_LOGIN.COM may be run during login to determine if the user has ever modified their own profile. If they have not entered their profile, UMP_LOGIN will ask them if they would like to do so immediately and @@ -6383,7 +6383,7 @@ install OECN$:UMPMODIFIED.EXE as a known image to speed up the login process. -

    12.17 UMPID2DIS - Creating Distribution Lists from VMS Identifiers (Optional)

    +

    UMPID2DIS - Creating Distribution Lists from VMS Identifiers (Optional)

    UMPID2DIS.EXE is an optional utility which builds PMDF style @@ -6487,7 +6487,7 @@
    $ EXIT -

    12.18 Example Procedure for Periodic Rebuilds

    +

    Example Procedure for Periodic Rebuilds

    Periodically, each site should run EXPORT_LISTS.COM to update the @@ -6665,7 +6665,7 @@

    -

    12.19 Multiple Non-Clustered Systems

    +

    Multiple Non-Clustered Systems

    DAS's with a single VMS system, or a single VMS cluster, need not be concerned with this section. @@ -6730,7 +6730,7 @@ one that needs to run the EXPORT_LISTS.COM to produce the mail_ and oecn_ for your DAS. -

    12.20 Programming Considerations

    +

    Programming Considerations

    DAS programmers may wish to use DTR, COBOL or other high level language @@ -6773,7 +6773,7 @@ -

    12.20.1 Field Requirements

    +

    Field Requirements

    Some fields in UMP may display to the user differently than is @@ -6804,7 +6804,7 @@


    -

    Chapter 13
    VFC2PDF - Converting Text Files to PDF Format

    +

    VFC2PDF - Converting Text Files to PDF Format

    VFC2PDF converts VFC or plain text files into PDF (Portable Document