I've just updated the user guide, transforming it from HTML format into
Pandoc.
Pandoc is a nice little tool, that uses markdown syntax (very similar to
lots of Wiki syntaxes), and can format a simple document into many
different formats including HTML, PDF, ODT, man pages... or other
"description formats" like LateX, DocBook... See
http://johnmacfarlane.net/pandoc/.
I think this format is easy enough for anyone to understand immediately.
I've created a Makefile to help generate the documentation. To use it,
just :
$ cd lsc-sample/doc/user-guide
$ make
I've set up a cron job on the webserver to update the documentation
online every night. You can see the first result here:
> http://lsc-project.org/user-guide/
As you can see, there is quite a lot to work on! I'd really appreciate
some help... the following are some things that clearly need doing:
- Writing more sections (even an outline is better than nothing)
- Working on the CSS for the HTML page
- Including some schemas in the documentation
Happy reading (and writing!) :)
Jonathan
On 30/10/2009 15:57, Jonathan Clarke wrote:
Hi,
I've started working on a documentation manual for LSC. The idea is to
explain clearly all details about using LSC.
The website has configuration reference and some tutorials. But I don't
think there is a clear description of "how to use LSC" yet.
This is a work in progress. I'm posting it here in the spirit of
"release early, release often". It's only for version 1.1 at the moment.
Feedback is most welcome! In particular:
- HTML is probably not the best format. What do you recommend? Docbook?
Textile? SDF? Latex? Something else?
- Are the contents right?
- Where should we put it? PDF in the source tarball? On the website?
Contributions are most welcome. Just send a patch or commit :)
Please check it out here:
http://tools.lsc-project.org/repositories/entry/lsc/lsc-sample/branches/v1.1/doc/UserGuide.html
(the best way is to download and open it in your browser)
Jonathan
_______________________________________________
lsc-users mailing list
[email protected]
http://lists.lsc-project.org/listinfo/lsc-users
--
--------------------------------------------------------------
Jonathan Clarke - [email protected]
--------------------------------------------------------------
Ldap Synchronization Connector (LSC) - http://lsc-project.org
--------------------------------------------------------------
_______________________________________________________________
Ldap Synchronization Connector (LSC) - http://lsc-project.org
lsc-users mailing list
[email protected]
http://lists.lsc-project.org/listinfo/lsc-users
