[Search for users] [Overall Top Noters] [List of all Conferences] [Download this site]

Conference vaxuum::document_ft

Title:DOCUMENT T1.0
Notice:**New notesfile (DOCUMENT.NOTE) now available (see note 897)**
Moderator:CLOSET::ADLER
Created:Mon Feb 09 1987
Last Modified:Thu Oct 31 1991
Last Successful Update:Fri Jun 06 1997
Number of topics:897
Total number of notes:4397

640.0. "SDML support in LSE is a tad clumsy" by CASEE::CLARK (Ward Clark) Fri Jul 10 1987 21:14

    First the good news:

    What a joy it is to start using a new tool, having to learn a new
    language and have LSE support INCLUDED WITH THE PRODUCT!  No midnight
    hours to add YAL (yet another language) to XLSE. 

    Now the bad news (but it's not that bad):

    Coming from a lot of experience using LSE with a variety of other
    languages, I found a number of situations where the SDML support seemed
    clumsy or incomplete.  Fortunately, those that I've found so far
    should be easy to resolve.

    My specific comments appear in the first few responses to this topic.

    -- Ward
T.RTitleUserPersonal
Name
DateLines
640.1< > \ should not be identifier charactersCASEE::CLARKWard ClarkFri Jul 10 1987 21:1812
    The set of SDML identifier characters includes the following:

	    < > \

    Since these characters determine "word" boundaries, word movement
    and deletion produce unexpected results.  For example,

	<TAGTHIS><TAGTHAT>WORD 1\2\3\4\5\6\7\8\9\10\11\12\13\14\15

    are treated as only *2* words!

    -- Ward
640.2unnecessary EXPANDingCASEE::CLARKWard ClarkFri Jul 10 1987 21:2128
    I've encountered several cases where double-EXPAND is required,
    probably because LSE V2 new placeholder features are not being used.
    For example, 

        table_setup 

    expands to 

        <TABLE_SETUP>({number}[\col-width]...) 

    where the second placeholder must be explicitly expanded: 

        <TABLE_SETUP>({number}\{number}[\col-width]...) 

    Instead, the initial expansion could be this: 

        <TABLE_SETUP>({number}\[col-width]...) 

    If this optional [col-width] placeholder is replaced with a number, it
    automatically duplicates with another "\".  Likewise, deleting the
    placeholder also deletes the preceding "\". 

    (Aside:  The [col-width] placeholder is actually required.) 

    It should be relatively easy to locate other examples of this
    unnecessary double-EXPANDing. 

    -- Ward
640.3[help-topic] placeholders shouldn't be thereCASEE::CLARKWard ClarkFri Jul 10 1987 21:3015
    The first few times I tried to use GOLD-Help to get help with language
    syntax, I got an error reporting that there was no help available for
    "[help-topic]". 

    I suspect what has happened here is that XLSE was used to create the
    LSE placeholder definitions and that some /HELP qualifier values were
    left specifying the XLSE [help-topic] optional placeholder. 

    Time to fire up XLSE again to find the remaining LSE placeholders.

    It would be wonderful to have real help topics.  (Beginning users can
    use a lot of help.)  A fallback is to just delete them and have LSE
    report that there is no help available.

    -- Ward
640.4DEFINE LANGUAGE SDML /WRAPCASEE::CLARKWard ClarkFri Jul 10 1987 21:3510
    XLSE's definition of the RUNOFF and LATEX languages include default
    wrapping of long streams of words, with a right margin of 75 (to leave
    a little editing space).

    I've found this simple default to be a great aid in entering a lot of
    text.

    I think that SDML should default to automatic wrapping.

    -- Ward
640.5Where do I put my module comments?CASEE::CLARKWard ClarkFri Jul 10 1987 21:5448
    I'm used to all LSE languages starting an empty buffer with a single
    placeholder which expands to a complete source file.  For example,
    LATEX (from XLSE) starts with this:

	[@module@]

    which EXPANDs to this:

	%[@software-copyright-statement@]
	%[@module-level-comments@]
	[@type_of_document@]
    
    The SDML support leaves out the first two placeholders.

    I could live without the copyright statement, but I really miss the
    model-level- comments.  That's where the purpose of the file and the
    modification history are documented.  This information seems just as
    relevant for DOCUMENT files as it is for other languages.  Including
    this section in the default template would encourage good DOCUMENT
    "programming" style.

    Here's something for starters:    

	DEFINE PLACEHOLDER module-level-comments -
	    /LANGUAGE=sdml -
	    /DESCRIPTION="description of the module" -
	    /TYPE=NONTERMINAL

	    "<COMMENT>"
	    "++"
	    "  Facility:"
	    "    [text]"
	    "  "
	    "  Abstract:"
	    "    [text]"
	    "  "
	    "  Author:"
	    "    [text]"
	    "  "
	    "  Creation Date: [text]"
	    "  "
	    "  Modification History:"
	    "--"
	    "<ENDCOMMENT>"

	    END DEFINE

    -- Ward