October 2004 - Koha-devel - lists.koha-community.org

Koha Documentation Structure
by Stephen Hedges 04 Oct '04

04 Oct '04

I have attached a file called "koha_docs_structure" which contains an outline for all of the Koha documentation. This is _not_ the documentation itself, but a description of the structure that will be used to organize the documents. (If you have trouble with the attachment, you should be able to find this file on Sourceforge at http://cvs.sourceforge.net/viewcvs.py/koha/koha-doc/ within the next few days.) The outline contains some words in brackets <Like This> that are names for document containers. Many of these containers simply hold other containers. Only the text that is not enclosed by brackets (for example, "Description in English") refers to an actual document. The goal is to have a place for every type of Koha-related document. If you have Koha-related documents that do not seem to have a place in the structure, please let me know. If you can think of some possible Koha-related documents that do not seem to have a place in the structure, please let me know. It is not intended that we have a document that matches every document described. But it is intended that every document that gets submitted can be easily "plugged in" to this document structure. I will be retrieving existing documents, such as Nicholas Rosasco's "Koha Manual," converting them to XML, and fitting them into this structure. All documents will be stored in XML format, but you can submit documents in any format that is comfortable for you. (XML was chosen as the format for storage because it is basic and can easily be converted to many other formats using a wide variety of tools.) I will also be looking through old e-mail messages for relevant information, and may contact some e-mail writers and ask that they expand their comments into a document that can be used as part of the Koha documentation. If you would like to submit a document, please include the following statement in the document: "This document is copyrighted (c) 2004 by <your name here>. Unless otherwise stated, Koha documents are copyrighted by their respective authors. Koha-related documents may be reproduced and distributed in whole or in part, in any medium physical or electronic, as long as this copyright notice is retained on all copies. You may create a derivative work and distribute it provided that you: 1. Send your derivative work to the Koha Project for possible posting on the Internet. 2. License the derivative work with this same license, or the Linux Documentation Project License (http://www.tldp.org/manifesto.html) or the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) Include a copyright notice and at least a pointer to the license used. 3. Give due credit to previous authors and major contributors. Commercial redistribution is allowed and encouraged; however, the author would like to be notified of any such distributions. Please check your local laws on copyright." OK, that's it. All comments or suggestions for improvement are welcome. --- Stephen Hedges Skemotah Solutions

3 3

RE: [Koha-devel] Koha Documentation Structure
by Anthony Youngman 04 Oct '04

04 Oct '04

Take a look at some of the O'Reilly books. I don't know how many of them are "Free" books that they have taken off the net, but there are a fair few where O'Reilly includes the source of the book and is not able to stop users copying the text. I thought DocBook was one of these but I'm not sure. If you want a "publisher friendly" licence, contact O'Reilly and ask them. As for all the documentation "being XML" and someone pointing out that XML is more a meta-format than a format, I would say that you should use DocBook for the documentation. I seem to remember hearing something about DocBook being updated recently, but it is a structured markup language, I think it does have an XML DTD, and it's pretty much the standard for Free Software documentation (the master copy, at least). The nice thing about it is that all the scripts, programs and everything are all there so that you can convert it into a help file, an html manual, a print manual, whatever. And if a publisher should decide it's worth printing, it's in a nice, convenient, STANDARD form for them to just drop into their system and run with ... Cheers, Wol -----Original Message----- From: koha-devel-admin(a)lists.sourceforge.net [mailto:koha-devel-admin@lists.sourceforge.net] On Behalf Of Joshua Ferraro Sent: 04 October 2004 15:15 To: koha-devel(a)lists.sourceforge.net Subject: Re: [Koha-devel] Koha Documentation Structure On Mon, Oct 04, 2004 at 02:39:49PM +0100, MJ Ray wrote: > froody... If you want CC, use that one ;-) Free software needs free > software manuals. However, I do think we should at least consider the possibility of a printed manual at some time in the future. So which license is likely not to prevent a publisher from signing on? Or would we self-publish? Joshua ------------------------------------------------------- This SF.net email is sponsored by: IT Product Guide on ITManagersJournal Use IT products in your business? Tell us what you think of them. Give us Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more http://productguide.itmanagersjournal.com/guidepromo.tmpl _______________________________________________ Koha-devel mailing list Koha-devel(a)lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/koha-devel **************************************************************************** This transmission is intended for the named recipient only. It may contain private and confidential information. If this has come to you in error you must not act on anything disclosed in it, nor must you copy it, modify it, disseminate it in any way, or show it to anyone. Please e-mail the sender to inform us of the transmission error or telephone ECA International immediately and delete the e-mail from your information system. Telephone numbers for ECA International offices are: Sydney +61 (0)2 8272 5300, Hong Kong + 852 2121 2388, London +44 (0)20 7351 5000 and New York +1 212 582 2333. ****************************************************************************

1 0

[OT] announce
by Paul POULAIN 02 Oct '04

02 Oct '04

Hello Koha developpers, I'm very, very, very happy to give you this link and announce that my 3rd son is born. Official annoucement (in french) and some pictures at : http://www.paulpoulain.com/jeremie/ -- Paul POULAIN Consultant indépendant en logiciels libres responsable francophone de koha (SIGB libre http://www.koha-fr.org)

3 2