Skip to Content.
Sympa Menu

devel - Re: [sympa-dev] Sympa reference manual source format : OpenOffice

Subject: Developers of Sympa

List archive

Chronological Thread  
  • From: address@concealed
  • To: address@concealed
  • Subject: Re: [sympa-dev] Sympa reference manual source format : OpenOffice
  • Date: Mon, 11 Sep 2006 17:26:05 -0400 (EDT)

Sympa Folks,

This whole problem of what to use as a documentation platform
for an open source project is certainly not a new one. So
one might ask, what do other successful open source projects
do? Here are three that quickly came to mind for me. Can
anybody else suggest some other interesting projects and find
out what they're doing?


- - - - - - - - - - - - - - - - - - - - -

Apache -- XML / HTML

http://apache-server.com/tutorials/ATdocs-project.html
http://httpd.apache.org/docs-project/docsformat.html

COMMENT: Second link talks about creating PDFs from the
XML. Sounds a bit painful.


- - - - - - - - - - - - - - - - - - - - -


Perl 6 -- POD and friends.

http://svn.perl.org/perl6/pugs/trunk/docs/README

"Plain text/minimal markup document formats are
preferred, such as POD, Kwid, Spork, and so on. There
seems to be a preference for Kwid for most general
documents, POD for AES drafts, Spork for slides, and
completely raw text for quickrefs."

COMMENT: "Kwid"? See:


http://search.cpan.org/dist/Perl6-Bible/lib/Perl6/Bible/S26.pod#THE_KWID_DIALECT


- - - - - - - - - - - - - - - - - - - - -


Ubuntu -- docbook

https://wiki.ubuntu.com/DocumentationTeam
https://wiki.ubuntu.com/DocumentationTeam/Contribute
http://doc.ubuntu.com/ubuntu/styleguide/en/index.html

COMMENT: Third link is to their style guide, a nice idea.


- - - - - - - - - - - - - - - - - - - - -


Just those three represent an interesting range of choices.

...BC

--
+-------------------------[ address@concealed ]---+
| Bill Costa | No good
| 1 Leavitt Lane Voice: | deed...
| CIS/Telecom -- 2nd Floor +1-603-862-3056 |
| University of New Hampshire | Goes
| Durham, NH 03824 USA | unpunished.
+---------------[ http://pubpages.unh.edu/~wfc/ ]--+



Archive powered by MHonArc 2.6.19+.

Top of Page