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


Ignore:
Timestamp:
Feb 5, 2014 11:08:22 AM (8 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/REQUEST

    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== REQUEST 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     Request -- Open a custom requester.  (V1.3.3) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K,BODY/A,GADGETS/A 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Opens a requester containing the supplied body and gadgets, and 
    1413     returns the choice taken by the user. 
    1514 
    16 '''INPUTS''' 
    17      VAR/K       - alternative variable to put the results into instead of RESULT (V2.0)\\ 
    18      STEM/K      - base name used for the stem where the result will be stored  (V2.0)\\ 
    19      BODY/A      - a string containing the body of the requester\\ 
    20      GADGETS/A   - a string containing a vertical bar ("|") separated list of gadget labels\\ 
     15 INPUTS:: 
     16     `VAR/K`       - alternative variable to put the results into instead of `RESULT` (V2.0)\\ 
     17     `STEM/K`      - base name used for the stem where the result will be stored  (V2.0)\\ 
     18     `BODY/A`      - a string containing the body of the requester\\ 
     19     `GADGETS/A`   - a string containing a vertical bar (`|`) separated list of gadget labels\\ 
    2120 
    22 '''RETURNS''' 
    23      VAR          - info returned by the query\\ 
    24      <STEM>RESULT - number of the selected gadget; may be 0 for the rightmost gadget, 1 for the leftmost gadget, and 2..n for the second, etc. gadget from the left\\ 
     21 RETURNS:: 
     22     `VAR`          - info returned by the query\\ 
     23     `<STEM>RESULT` - number of the selected gadget; may be 0 for the rightmost gadget, 1 for the leftmost gadget, and 2..n for the second, etc. gadget from the left\\ 
    2524 
    26 '''NOTES''' 
     25 NOTES:: 
    2726     Following the MUI specs, every gadget can have a shortcut by 
    28      inserting a '_' (underscore) character in front of the character 
     27     inserting a `_` (underscore) character in front of the character 
    2928     that should be used as shortcut.  A default gadget can also be 
    3029     defined with a '*' (asterisk) character in front; the default 
     
    3837     by the <Esc> key, and should always offer a safe way out. 
    3938 
    40 '''EXAMPLE''' 
    41          /* Enable result codes */\\ 
    42          OPTIONS RESULTS 
     39 EXAMPLE:: 
     40     {{{#!urbiscript 
     41     /* Enable result codes */ 
     42     OPTIONS RESULTS 
    4343 
    44          /* Prepare the text for our requester.\\ 
    45          !* Here we have to escape the single '*' (asterisk) via\\ 
    46          !* an additional asterisk sign because an asterisk is\\ 
    47          !* a reserved character for ARexx itself\\ 
    48          */\\ 
    49          body = '"Isn't YAM just great?"'\\ 
    50          gadgets = '"!**_Yeah!|_No way, Outlook rules!|_What is YAM?"'\\ 
     44     /* Prepare the text for our requester. 
     45       * Here we have to escape the single '*' (asterisk) via 
     46       * an additional asterisk sign because an asterisk is 
     47       * a reserved character for ARexx itself 
     48       */ 
     49     body = '"Is YAM just great?"' 
     50     gadgets = '"!**_Yeah!|_No way, Outlook rules!|_What is YAM?"' 
    5151 
    52          /* Open a custom requester */\\ 
    53          REQUEST body gadgets\\ 
     52     /* Open a custom requester */ 
     53     REQUEST body gadgets 
     54     }}} 
    5455 
    55 '''BUGS''' 
     56 BUGS:: 
    5657 
    57 '''SEE ALSO''' 
     58 SEE ALSO::