Re: Documentation workflow

Am Sonntag, den 22.05.2005, 03:28 +0200 schrieb Rakotomandimby (R12y)
Mihamina:
> Hi,
> 
> I made very basic tutorials that could help beginners to use Ocamlnet.
> I would like them to be included into the main documentation, like here:
> http://ocamlnet.sourceforge.net/manual/refman/Netchannels.html
> http://ocamlnet.sourceforge.net/manual/refman/Nethtml.html
> 
> My tutorials are mostly about Using NEthtml in CGI scripts. Here is the
> French version, in construction:
> 
> http://www.etud-orleans.fr/Members/mihamina/dev/ocamlnethtml
> 
> I still have to finish the Nethtml -> Netcgi "interconnexion".
> 
> I will translate some of them in English but would like some examples to
> be inserted in the documentation, so:
> 
> What is the way of work?
> 
> - Have I just to write the stuff in plain texte then you process it with
> some tool? (I dont think I'll have the time to learn using your html
> generation tool...)
> - Have  just to edit the HTML documentation file in the source tarbal
> then submit it here?

Sorry for letting you wait so long.

The reference manual is generated from Ocamldoc markup embedded in the
sources (look into e.g. nethtml.ml). The markup is very simple:

- Put small code sections into brackets, e.g. the variable [x]
- Multi-line code sections go between {[ ]}, e.g.
  {[ let sample() =
       ...
  ]}
- Headings are: {1 First level}, {2 Second level}, etc.

It would be nice if you could stick to these three rules; I can do the
fine-tuning.

Gerd
-- 
------------------------------------------------------------
Gerd Stolpmann * Viktoriastr. 45 * 64293 Darmstadt * Germany 
[email protected]          http://www.gerd-stolpmann.de
------------------------------------------------------------




-------------------------------------------------------
SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
from IBM. Find simple to follow Roadmaps, straightforward articles,
informative Webcasts and more! Get everything you need to get up to
speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click