[OPEN-ILS-DOCUMENTATION] ***SPAM*** Re: Evergreen Documentation a few questions

[Karen Collier]

Robert,

Both excellent questions.  

As I understand it, Docbook is the preferred format for submissions, but we'll accept pretty much any format and convert it as needed.  There is no official template yet, as far as I know, but I remember some discussion a while ago that a template would be a huge benefit.  Has anyone been working on a template?  Anyone want to offer to work toward one?

No convention for cross-references yet.  Anyone more familiar with DocBook than I want to suggest a convention?

Thanks,
Karen

----- "Robert Soulliere" <robert.soulliere at mohawkcollege.ca> wrote:

> Hi DIGers,
> 
> I just had few questions regarding documentation conventions etc...
> 
> 1) What is the convention for cross referencing or linking to other
> sections of the Book of Evergreen which we may not be working on. For
> example, Upgrading instructions requires referencing the OpenSRF
> install instructions. Moreover, we may also need to reference a
> subsection of a completely different chapter we are not working on. Is
> there a standard convention to make this easy for the final process if
> bring all the sections together.
> 
> 2) I am still murky on preferred format of submissions: Word, DocBook
> or other? If we are to submit our sections in DocBook xml format, do
> we have an official DIG Evergreen template to follow in order to
> maintain uniformity and consistency or is that going to be sorted out
> later?
> 
> I apologize if this has already been communicated but I missed it.
> 
> Thanks,
> Robert
> 
> Robert Soulliere
> Systems Librarian
> robert.soulliere at mohawkcollege.ca
> Tel: 905-575-1212 X3936
> 
> Library at Mohawk
> Connect * Learn * Succeed
> brain.mohawkcollege.ca
> 
> -----Original Message-----
> From: open-ils-documentation-bounces at list.georgialibraries.org
> [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On
> Behalf Of Karen Collier
> Sent: January 7, 2010 4:05 PM
> To: Documentation discussion for Evergreen software
> Subject: Re: [OPEN-ILS-DOCUMENTATION] Evergreen Documentation
> Licensing Terms
> 
> Whoops!  Meant to include a link to the outline.  Here it is!
> 
> http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:outline
> 
> Karen
> 
> ----- "Karen Collier" <kcollier at kent.lib.md.us> wrote:
> 
> > Well, the deadline has passed, and I count 18 "yes" votes to zero
> "no"
> > votes.  Congratulations everybody, DIG has unanimously selected
> > licensing terms for official Evergreen documentation.  The
> licensing
> > terms are below and have been posted on the wiki at
> >
> http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:documentation_licensing_terms.
> >  I'll get started working on notifying people of these terms, and
> how
> > they relate to the wiki (part 4).
> >
> > For pre-existing documentation that did not originate on the wiki,
> it
> > would be ideal to get official permission to use that documentation
> > under these licensing terms.  If you are the copyright owner, have
> > permission from the copyright owner, or otherwise have the right to
> > agree to these terms on behalf of some of this pre-existing
> > documentation, please do so by submitting the documentation to the
> > mailing list (either by attachment or if the file is big by linking
> to
> > it) and stating that you agree to its use under Evergreen's
> > Documentation Licensing Terms
> >
> (http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:documentation_licensing_terms).
> >  If you're not the right person to agree, but know who is, please
> talk
> > to that person about it.
> >
> > I would love to see us get documentation writing off to a running
> > start in 2010.  To this end, perhaps those with a few minutes could
> > take a look at the proposed documentation outline and consider what
> > portion you would like to begin working on.  Drop an email to
> > docs at evergreen-ils.org to let the facilitators know.
> >
> > Happy New Year!
> >
> > Thanks,
> > Karen
> >
> > ----- "Karen Collier" <kcollier at kent.lib.md.us> wrote:
> >
> > > As discussed at the Documentation Interest Group Meeting on
> > December,
> > > 9, 2009, I am calling for a vote on Documentation Licensing.
> > Members
> > > of the Documentation Interest Group and interested members of the
> > > Evergreen Community, please vote yes or no on the following
> > proposals
> > > by Monday, January 4, 2009 by replying to this email on the
> > Evergreen
> > > Documentation mailing list
> > > (open-ils-documentation at list.georgialibraries.org).
> > >
> > > 1 - Official Evergreen Documentation produced by the
> Documentation
> > > Interest Group should be licensed under the Creative Commons
> > > Attribution Share-Alike 3.0 License
> > > (http://creativecommons.org/licenses/by-sa/3.0/).
> > >
> > > 2 - Any code included in the official documentation produced by
> the
> > > Documentation Interest Group should also be made available under
> > the
> > > GNU GPL (http://www.gnu.org/licenses/gpl.html).
> > >
> > > 3 - Official Evergreen Documentation may be made available under
> > > another copy-left
> > (http://www.fsf.org/licensing/essays/copyleft.html)
> > > open source (http://www.opensource.org/docs/osd) license in the
> > future
> > > with a majority vote on the Evergreen Documentation List
> > > (open-ils-documentation at list.georgialibraries.org) or comparable
> > > indication of the Evergreen community's wishes.
> > >
> > > 4 - These same licensing terms should be applied to the
> > Documentation
> > > Wiki.  Past contributors to the Documentation Wiki should be
> > notified
> > > by emails sent to Evergreen community mailing lists and to the
> > email
> > > address associated with their docuwiki account of the new
> licensing
> > > terms and given a reasonable amount of time to request that their
> > > contributions not be included under those licensing terms.
> > >
> > > 5 - By submitting documentation to the Documentation wiki or to
> the
> > > Evergreen Documentation List after licensing terms have been
> > decided
> > > and publicized, contributors indicate that they (a) agree to
> these
> > > licensing terms, and (b) to the best of their knowledge have the
> > right
> > > to do so through copyright ownership, permission from the
> copyright
> > > owner(s), and/or the licensing terms of any documents that were
> > > modified or incorporated into their submission.
> > >
> > > --
> > > Karen Collier
> > > Public Services Librarian
> > > Kent County Public Library
> > > 408 High Street
> > > Chestertown, MD 21620
> > > 410-778-3636
> > > _______________________________________________
> > > OPEN-ILS-DOCUMENTATION mailing list
> > > OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> > >
> >
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
> >
> > --
> > Karen Collier
> > Public Services Librarian
> > Kent County Public Library
> > 408 High Street
> > Chestertown, MD 21620
> > 410-778-3636
> > _______________________________________________
> > OPEN-ILS-DOCUMENTATION mailing list
> > OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> >
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
> 
> --
> Karen Collier
> Public Services Librarian
> Kent County Public Library
> 408 High Street
> Chestertown, MD 21620
> 410-778-3636
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
> 
> This E-mail contains privileged and confidential information intended
> only for the individual or entity named in the message.  If the
> reader
> of this message is not the intended recipient, or the agent
> responsible
> to deliver it to the intended recipient, you are hereby notified that
> any review, dissemination, distribution or copying of this
> communication
> is prohibited.  If this communication was received in error, please
> notify the sender by reply E-mail immediately, and delete and destroy
> the original message.
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation

-- 
Karen Collier
Public Services Librarian
Kent County Public Library
408 High Street
Chestertown, MD 21620
410-778-3636