Changes between Version 3 and Version 8 of Documentation/ARexxAPI/ADDREDIT


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

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDREDIT

    v3 v8  
    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== ADDREDIT
    54
    6 '''NAME'''
    7      AddrEdit -- Fill in the fields of the current address book entry.
    8                  (V2.0)
     5 NAME::
     6     AddrEdit -- Fill in the fields of the current address book entry. (V2.0)
    97
    10 '''TEMPLATE'''
     8 TEMPLATE::
    119     ALIAS,NAME,EMAIL,PGP,HOMEPAGE,STREET,CITY,COUNTRY,PHONE,COMMENT,
    1210     BIRTHDATE/N,IMAGE,MEMBER/M,ADD/S
    1311
    14 '''FUNCTION'''
     12 FUNCTION::
    1513     Edits the fields of the current address book entry.
    1614
    17 '''INPUTS'''
    18      ALIAS         - alias for the entry (upto 29 chars)\\
    19      NAME          - real name for the entry (upto 39 chars)\\
    20      EMAIL         - email address for the entry\\
    21      PGP           - PGP ID for the entry (person only)\\
    22      HOMEPAGE      - homepage for the entry (person only) (upto 231 chars)\\
    23      STREET        - snail mail address of the entry (person only) (upto 79 chars)\\
    24      CITY          - city for the entry (person only) (upto 79 chars)\\
    25      COUNTRY       - country for the entry (person only) (upto 79 chars)\\
    26      PHONE         - phone # for the entry (person only) (upto 79 chars)\\
    27      COMMENT       - comment for the entry (up to 79 chars)\\
    28      BIRTHDATE/N   - birthdate for a person in DDMMYYYY format, e.g. 13091969\\
    29      IMAGE         - image filename for the entry (person only)\\
    30      MEMBER/M      - use the argument(s) to edit a member list\\
    31      ADD/S         - combined with 'member', adds new members to a distribution list, instead of replacing the old member info\\
     15 INPUTS::
     16     `ALIAS`         - alias for the entry (upto 29 chars)\\
     17     `NAME`          - real name for the entry (upto 39 chars)\\
     18     `EMAIL`         - email address for the entry\\
     19     `PGP`           - PGP ID for the entry (person only)\\
     20     `HOMEPAGE`      - homepage for the entry (person only) (upto 231 chars)\\
     21     `STREET`        - snail mail address of the entry (person only) (upto 79 chars)\\
     22     `CITY`          - city for the entry (person only) (upto 79 chars)\\
     23     `COUNTRY`       - country for the entry (person only) (upto 79 chars)\\
     24     `PHONE`         - phone # for the entry (person only) (upto 79 chars)\\
     25     `COMMENT`       - comment for the entry (up to 79 chars)\\
     26     `BIRTHDATE/N`   - birthdate for a person in DDMMYYYY format, e.g. 13091969\\
     27     `IMAGE`         - image filename for the entry (person only)\\
     28     `MEMBER/M`      - use the argument(s) to edit a member list\\
     29     `ADD/S`         - combined with 'member', adds new members to a distribution list, instead of replacing the old member info\\
    3230
    33 '''RETURNS'''
    34      RC is set 10 if no entry is currently selected in the address book.
     31 RETURNS::
     32     `RC` is set 10 if no entry is currently selected in the address book.
    3533
    36 '''NOTES'''
     34 NOTES::
    3735     Arguments longer than the available space are simply truncated.
    3836
    39 '''EXAMPLE'''
    40          /* Enable result codes */
     37 EXAMPLE::
     38{{{#!arexx
    4139
    42          OPTIONS RESULTS
     40/* Enable result codes */
     41OPTIONS RESULTS
    4342
    44          /* Select an entry */
     43/* Select an entry */
     44ADDRGOTO YAM_ml
    4545
    46          ADDRGOTO YAM_ml
     46/* Edit this entry */
     47'ADDREDIT EMAIL "yam@freelists.org" COMMENT "The place to be"'
    4748
    48          /* Edit this entry */
     49/* Select a distribution list */
     50ADDRGOTO blacklisted
    4951
    50          'ADDREDIT EMAIL "yam@freelists.org" COMMENT "The place to be"'
     52/* Reset the list */
     53ADDREDIT MEMBER 'bill'
    5154
    52          /* Select a distribution list */
     55/* Add a couple of members */
     56ADDREDIT MEMBER 'jobs@example.com' MEMBER 'smith@example.net' ADD
     57}}}
    5358
    54          ADDRGOTO blacklisted
    55 
    56          /* Reset the list */
    57 
    58          ADDREDIT MEMBER 'bill'
    59 
    60          /* Add a couple of members */
    61 
    62          ADDREDIT MEMBER 'jobs@example.com' MEMBER 'smith@example.net' ADD
    63 
    64 '''BUGS'''
    65      Even if a group or person is selected, MEMBER [ADD] will return
     59 BUGS::
     60     Even if a group or person is selected, `MEMBER [ADD]` will return
    6661     success (0).
    6762
     
    6964     would throw Enforcer hits; this was fixed in V2.4.
    7065
    71 '''SEE ALSO'''
     66 SEE ALSO::