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


Ignore:
Timestamp:
Feb 5, 2014, 9:38:00 AM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/MAILEDIT

    v3 v4  
    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== MAILEDIT
    54
    6 '''NAME'''
     5 NAME::
    76     MailEdit -- Edit the current message in a new Write window.  (V2.0)
    87
    9 '''TEMPLATE'''
     8 TEMPLATE::
    109     VAR/K,STEM/K,QUIET/S
    1110
    12 '''FUNCTION'''
     11 FUNCTION::
    1312     Opens a new Write window to edit the selected message.
    1413
    15 '''INPUTS'''
    16      VAR/K     - alternative variable to store the number of the created window instead of RESULT\\
    17      STEM/K    - base name used for the stem where the returned data will be stored\\
    18      QUIET/S   - force the window to stay invisible  (V2.1)\\
     14 INPUTS::
     15     `VAR/K`     - alternative variable to store the number of the created window instead of `RESULT`\\
     16     `STEM/K`    - base name used for the stem where the returned data will be stored\\
     17     `QUIET/S`   - force the window to stay invisible  (V2.1)\\
    1918
    20 '''RETURNS'''
    21      VAR          - info returned by the command\\
    22      <STEM>WINDOW - number of the created window, may be either 0 or 1 (or 2, if QUIET is enabled)\\
     19 RETURNS::
     20     `VAR`          - info returned by the command\\
     21     `<STEM>WINDOW` - number of the created window\\
    2322
    24      RC is set to 10 if the window cannot be opened, maybe because the
     23     `RC` is set to 10 if the window cannot be opened, maybe because the
    2524     limit of two Write windows has been reached.
    2625
    27 '''NOTES'''
     26 NOTES::
    2827     The command works even with email that is NOT intended as "outgoing",
    2928     like email in the Incoming folder for instance, in which case the
     
    3635     by the time it is again saved.  Handle with caution.
    3736
    38 '''EXAMPLE'''
    39          /* Select the first message in the Outgoing folder */
     37 EXAMPLE::
     38     {{{#!urbiscript
     39     /* Select the first message in the Outgoing folder */
     40     SETFOLDER Outgoing
     41     SETMAIL 0
    4042
    41          SETFOLDER Outgoing\\
    42          SETMAIL 0\\
     43     /* Edit this message */
     44     MAILEDIT
    4345
    44          /* Edit this message */
     46     /* Change the subject */
     47     'WRITESUBJECT "Email address change"'
    4548
    46          MAILEDIT
     49     /* Put the message again in the queue */
     50     WRITEQUEUE
     51     }}}
    4752
    48          /* Change the subject */
     53 BUGS::
    4954
    50          'WRITESUBJECT "Email address change"'
    51 
    52          /* Put the message again in the queue */
    53 
    54          WRITEQUEUE
    55 
    56 '''BUGS'''
    57 
    58 '''SEE ALSO'''
     55 SEE ALSO::