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


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRNEW

    v3 v7  
    1 [[TranslatedPages]]\\
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]]
    3 
     1[[TranslatedPages]]
     2[[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
    43== ADDRNEW
    54
    6 '''NAME'''
     5 NAME::
    76     AddrNew -- Create a new entry in the address book.  (V2.0)
    87
    9 '''TEMPLATE'''
     8 TEMPLATE::
    109     VAR/K,STEM/K,TYPE,ALIAS,NAME,EMAIL
    1110
    12 '''FUNCTION'''
     11 FUNCTION::
    1312     Creates a new entry in the address book and inserts it below
    1413     the last active entry.  If the address book window has not yet
     
    1615     below the first entry.
    1716
    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\\
     17 INPUTS::
     18     `VAR/K`    - variable where the alias of the resulting entry will be stored\\
     19     `STEM/K`   - base name used for the stem where the alias of the resulting entry will be stored\\
     20     `TYPE`     - type of entry, may be one of G (group), L (distribution list) or P (person, the default value)\\
     21     `ALIAS`    - alias for the new entry\\
     22     `NAME`     - real name for the new entry\\
     23     `EMAIL`    - email address for the new entry\\
    2524
    26 '''RETURNS'''
    27      VAR         - alias of the resulting entry\\
    28      <STEM>ALIAS - alias of the resulting entry\\
     25 RETURNS::
     26     `VAR`         - alias of the resulting entry\\
     27     `<STEM>ALIAS` - alias of the resulting entry\\
    2928
    30 '''NOTES'''
    31      At least one of ALIAS, NAME or EMAIL should be specified.  Bogus
     29 NOTES::
     30     At least one of `ALIAS`, `NAME` or `EMAIL` should be specified.  Bogus
    3231     types are simply ignored.
    3332
     
    3837
    3938     If no alias is provided, one will be created automatically by
    40      using a cut-down version of the NAME or EMAIL arguments; for
    41      instance, "Jose Luis Feliciano" would turn into "J_Feliciano",
    42      or "Jose" if Jose@example.com was the only argument provided.
     39     using a cut-down version of the `NAME` or `EMAIL` arguments; for
     40     instance, "Jose Luis Feliciano" would turn into `J_Feliciano`,
     41     or `Jose` if `Jose@example.com` was the only argument provided.
    4342     The rule mentioned above is also applied.
    4443
     
    5049     While using spaces in aliases is possible, it is discouraged.
    5150
    52 '''EXAMPLE'''
    53          /* Create a new group */
     51 EXAMPLE::
     52     {{{#!arexx
     53     /* Create a new group */
     54     ADDRNEW G 'Singers'
    5455
    55          ADDRNEW G 'Singers'
     56     /* Create a new distribution list */
     57     ADDRNEW L 'Spanish'
     58     }}}
    5659
    57          /* Create a new distribution list */
     60 BUGS::
    5861
    59          ADDRNEW L 'Spanish'
    60 
    61 '''BUGS'''
    62 
    63 '''SEE ALSO'''
    64      [[ARexx API/ADDREDIT| ADDREDIT ]]
     62 SEE ALSO::
     63     [[ADDREDIT]]