On 7/12/07, Viktor Griph <[EMAIL PROTECTED]> wrote:
On Thu, 12 Jul 2007, seventh guardian wrote:
> About the doc page creation, it seemed simple at first, but I had to
> search hard for the relevant info. Maybe a clearer how-to should be
> created? This is the first time I'm creating a manual entry, so here
> are my steps:
>
> 1. enter doc/commands
> 2. copy a similar command like Echo.xml to EchoFuncDefinition.xml
>
> 3. change the section id, title and cmdsynopsis to the correct name
> 4. change the arg in cmdsynopsis from 'string' to 'function'
>
> 5. change the "para" section according to the previous menu entry,
> noting that the reference to the 'Echo' command should obey the
> convention in README in order to generate an appropriate link. It
> would become like this:
>
> [...]
>
> 6. now it's time for adding it to doc/fvwm/userFunctions.xml, which
> seems the most relevant group for it.
>
> 7. then add it to the Makefile.am COMMANDS variable.
> 8. finally it's a matter of creating a changelog entry and adding it to cvs
>
> This seems fairly simple now, but took me some time to figure out. I
> believe there should be a how-to somewhere.. Maybe I'll do it, as soon
> as I get in the mood ( now is time for lunch :)
>
I believe you vate to add it to groupedCommands.html and there seems to be
some script to run to have it added to allCommands.html.
Oh.. Will you correct that please? The how-to is really needed.. The
organization seems good though, modular files make it easy to maintain
(but maybe not to add new stuff).
Renato
