macro for api-documentation

macro for api-documentation

[Janko Hauser]

[-- Attachment #1.1: Type: text/plain, Size: 1205 bytes --]

Hello everyone, good morning europe, I want to generate an API- 
documentation. For this I use a table (bTABLE) for every function  
definition. That's a lot of code, which is in part dynamic (number of  
rows for example depends on number of arguments). Here is a simple  
example, but I will need colors and different fonts, different lines  
between in/out and so on.

\startalignment[middle]
\midaligned{\ss
\bTABLE
\bTR \bTD[nc=3] validateRegistration \eTD  \eTR
\bTR \bTD[nr=3] \rotate[rotation=90]{Input} \eTD \bTD parameter1 \eTD  
\bTD Beschreibung zu
Parameter 1  \eTD \eTR
\bTR \bTD parameter2 \eTD \bTD Beschreibung zu
Parameter 2  \eTD \eTR
\bTR \bTD parameter2 \eTD \bTD Beschreibung zu
Parameter 2  \eTD \eTR
\bTR \bTD[nr=3] \rotate[rotation=90]{Output} \eTD \bTD parameter1  
\eTD \bTD Beschreibung zu
Parameter 1  \eTD \eTR
\bTR \bTD parameter2 \eTD \bTD Beschreibung zu
Parameter 2  \eTD \eTR
\bTR \bTD parameter3 \eTD \bTD Beschreibung zu
Parameter 3  \eTD \eTR
\eTABLE}
\stopalignment


Are there any examples to do this more generally or better approaches  
to set this up?

With regards,

__Janko

-- 
Janko Hauser  email:  jhauser@zscout.de
               mobile: +49 1721 641552



[-- Attachment #1.2: Signierter Teil der Nachricht --]
[-- Type: application/pgp-signature, Size: 155 bytes --]

[-- Attachment #2: Type: text/plain, Size: 139 bytes --]

_______________________________________________
ntg-context mailing list
ntg-context@ntg.nl
http://www.ntg.nl/mailman/listinfo/ntg-context

Re: macro for api-documentation

[Wolfgang Schuster]

[-- Attachment #1.1: Type: text/plain, Size: 2204 bytes --]

2007/4/13, Janko Hauser <jh@zscout.de>:
>
> Hello everyone, good morning europe, I want to generate an API-
> documentation. For this I use a table (bTABLE) for every function
> definition. That's a lot of code, which is in part dynamic (number of
> rows for example depends on number of arguments). Here is a simple
> example, but I will need colors and different fonts, different lines
> between in/out and so on.
>
> \startalignment[middle]
> \midaligned{\ss
> \bTABLE
> \bTR \bTD[nc=3] validateRegistration \eTD  \eTR
> \bTR \bTD[nr=3] \rotate[rotation=90]{Input} \eTD \bTD parameter1 \eTD
> \bTD Beschreibung zu
> Parameter 1  \eTD \eTR
> \bTR \bTD parameter2 \eTD \bTD Beschreibung zu
> Parameter 2  \eTD \eTR
> \bTR \bTD parameter2 \eTD \bTD Beschreibung zu
> Parameter 2  \eTD \eTR
> \bTR \bTD[nr=3] \rotate[rotation=90]{Output} \eTD \bTD parameter1
> \eTD \bTD Beschreibung zu
> Parameter 1  \eTD \eTR
> \bTR \bTD parameter2 \eTD \bTD Beschreibung zu
> Parameter 2  \eTD \eTR
> \bTR \bTD parameter3 \eTD \bTD Beschreibung zu
> Parameter 3  \eTD \eTR
> \eTABLE}
> \stopalignment
>
>
> Are there any examples to do this more generally or better approaches
> to set this up?
>
> With regards,
>
> __Janko


Hi Janko,

\starttext

\placetable
{none}
{\setupTABLE[style=sans]
\setupTABLE[c][1][left=\rotate\bgroup,right=\egroup]
\setupTABLE[1][1][left=,right=]
\bTABLE
  \bTR
    \bTD[nc=3] validateRegistration \eTD
  \eTR
  \bTR
    \bTD[nr=3] Input \eTD
    \bTD parameter1 \eTD
    \bTD Beschreibung zu Parameter 1 \eTD
  \eTR
  \bTR
    \bTD parameter2 \eTD
    \bTD Beschreibung zu Parameter 2 \eTD
  \eTR
  \bTR
    \bTD parameter2 \eTD
    \bTD Beschreibung zu Parameter 2 \eTD
  \eTR
  \bTR
    \bTD[nr=3] Output \eTD
    \bTD parameter1 \eTD
    \bTD Beschreibung zu Parameter 1 \eTD
  \eTR
  \bTR
    \bTD parameter2 \eTD
    \bTD Beschreibung zu Parameter 2 \eTD
  \eTR
  \bTR
    \bTD parameter3 \eTD
    \bTD Beschreibung zu Parameter 3 \eTD
  \eTR
\eTABLE}

\stoptext

you can use \placetable or any other coammand defined with \definfloat to
center your  figures, tables ...  Another positive effect is that setups are
local
to the current float.

Greetings from Ingolstadt

Wolfgang

[-- Attachment #1.2: Type: text/html, Size: 3042 bytes --]

[-- Attachment #2: Type: text/plain, Size: 139 bytes --]

_______________________________________________
ntg-context mailing list
ntg-context@ntg.nl
http://www.ntg.nl/mailman/listinfo/ntg-context