Changes between Version 3 and Version 4 of Documentation/ARexxAPI/ADDRNEW


Ignore:
Timestamp:
Feb 4, 2014, 4:49:57 PM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRNEW

    v3 v4  
    1 [[TranslatedPages]]\\
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]]
    3 
     1[[TranslatedPages]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
    42== ADDRNEW
    53
    6 '''NAME'''
     4 NAME::
    75     AddrNew -- Create a new entry in the address book.  (V2.0)
    86
    9 '''TEMPLATE'''
     7 TEMPLATE::
    108     VAR/K,STEM/K,TYPE,ALIAS,NAME,EMAIL
    119
    12 '''FUNCTION'''
     10 FUNCTION::
    1311     Creates a new entry in the address book and inserts it below
    1412     the last active entry.  If the address book window has not yet
     
    1614     below the first entry.
    1715
    18 '''INPUTS'''
    19      VAR/K    - variable where the alias of the resulting entry will be stored\\
    20      STEM/K   - base name used for the stem where the alias of the resulting entry will be stored\\
    21      TYPE     - type of entry, may be one of G (group), L (distribution list) or P (person, the default value)\\
    22      ALIAS    - alias for the new entry\\
    23      NAME     - real name for the new entry\\
    24      EMAIL    - email address for the new entry\\
     16 INPUTS::
     17     `VAR/K`    - variable where the alias of the resulting entry will be stored\\
     18     `STEM/K`   - base name used for the stem where the alias of the resulting entry will be stored\\
     19     `TYPE`     - type of entry, may be one of G (group), L (distribution list) or P (person, the default value)\\
     20     `ALIAS`    - alias for the new entry\\
     21     `NAME`     - real name for the new entry\\
     22     `EMAIL`    - email address for the new entry\\
    2523
    26 '''RETURNS'''
    27      VAR         - alias of the resulting entry\\
    28      <STEM>ALIAS - alias of the resulting entry\\
     24 RETURNS::
     25     `VAR`         - alias of the resulting entry\\
     26     `<STEM>ALIAS` - alias of the resulting entry\\
    2927
    30 '''NOTES'''
    31      At least one of ALIAS, NAME or EMAIL should be specified.  Bogus
     28 NOTES::
     29     At least one of `ALIAS`, `NAME` or `EMAIL` should be specified.  Bogus
    3230     types are simply ignored.
    3331
     
    3836
    3937     If no alias is provided, one will be created automatically by
    40      using a cut-down version of the NAME or EMAIL arguments; for
     38     using a cut-down version of the `NAME` or `EMAIL` arguments; for
    4139     instance, "Jose Luis Feliciano" would turn into "J_Feliciano",
    4240     or "Jose" if Jose@example.com was the only argument provided.
     
    5048     While using spaces in aliases is possible, it is discouraged.
    5149
    52 '''EXAMPLE'''
    53          /* Create a new group */
     50 EXAMPLE::
     51     {{{#!urbiscript
     52     /* Create a new group */
     53     ADDRNEW G 'Singers'
    5454
    55          ADDRNEW G 'Singers'
     55     /* Create a new distribution list */
     56     ADDRNEW L 'Spanish'
     57     }}}
    5658
    57          /* Create a new distribution list */
     59 BUGS::
    5860
    59          ADDRNEW L 'Spanish'
    60 
    61 '''BUGS'''
    62 
    63 '''SEE ALSO'''
    64      [[ARexx API/ADDREDIT| ADDREDIT ]]
     61 SEE ALSO::
     62     [[ADDREDIT]]