[OPEN-ILS-DOCUMENTATION] Documentation updates

Karen Collier kcollier at kent.lib.md.us
Wed Aug 11 14:28:05 EDT 2010


I'm a bit leery of mixing attribution within the main body of the documentation.  It could get pretty unwieldy if we're putting attribution statements on every page, and how do you decide which pages warrant their own attribution statement and which don't?  Particularly after all the "adding, mashing, mixing, remixing, revising, editing, etc" that Robert refers to it could become a real mess.  If SITKA and other contributors are amenable, I think it would be preferable to limit the attribution statements to a statement in the Introduction (http://libdog.mohawkcollege.ca/evergreen_documentation/draft/html/pt01.html) that directs readers to the appendix devoted specifically to recognizing contributors.  We haven't created that appendix just yet, but it's probably time.

Thoughts?  Agreement?  Disagreement?

Thanks,
Karen

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

> jenny,
> 
> That is a good question. The other question is at which document level
> we need to add a statement like this: part, chapter, section, every
> paragraph?
> 
> If one of these divisions is static in that it is the content of a
> person or corporate entity, I think that a statement can be added in
> the intro to that particular part or chapter. However, this becomes
> more complex if a section  is dynamic in that content would be
> contributed from a number of sources which would be my expectation
> over time. Moreover, I suspect that there is going to be a lot of
> adding, mashing, mixing, remixing, revising, editing, etc... over time
> by a lot of participants for a lot of different places.
> 
> I wonder if a statement could be added to the copyright statement at
> the beginning of the document and the copyright statement at the
> bottom left of the document pages to give a list of all the sources
> for the documentation indicating that "much of this documentation in
> based on that made available through SITKA Evergreen
> (http://sitka.bclibraries.ca/) etc..."?
> 
> As well, corporate entities involved in the documentation should also
> be listed in the Appendix chapter:
> "About This Documentation and DIG (Call for participation & credit for
> participants)"
> 
> Would that be sufficient?
> 
> Robert
> 
> 
> ________________________________________
> From: open-ils-documentation-bounces at list.georgialibraries.org
> [open-ils-documentation-bounces at list.georgialibraries.org] On Behalf
> Of Turner, Jennifer M [jennifer.turner at mnsu.edu]
> Sent: August 10, 2010 5:34 PM
> To: Documentation discussion for Evergreen software;
> open-ils-general at list.georgialibraries.org;
> open-ils-dev at list.georgialibraries.org
> Subject: Re: [OPEN-ILS-DOCUMENTATION] Documentation updates
> 
> Hello Robert and All,
> 
> >I've updated a number of sections of the Evergreen documentation. I
> found much of content including >screen shots on SITKA's DocBook site.
> I hope they don't mind. I've tried to make it as generic as >possible.
> I've updated the documentation outline page to reflect the content
> sources.
> 
> I've been in contact with the folks at SITKA for the documentation I
> modified and "generic-ified" for training our library system and then
> submitted to the list.  The share-and-share-alike licensing permits
> this, provided they receive attribution for their share of the work. I
> used the following statement:
> 
> This documentation in based on that made available through SITKA
> Evergreen (http://sitka.bclibraries.ca/) and on the documentation
> available on the Evergreen website (http://evergreen-ils.org).
> 
> Perhaps someone has a good idea of how a statement like this might be
> made apparent on the sections that are heavily reliant on one source?
> 
> Jenny
> 
> ==============================
> Jennifer Turner
> PALS, A Program of the Minnesota State Colleges and Universities
> Minnesota State University, Mankato
> ML 3022
> Mankato, MN 56001
> 507-389-2000
> 
> * Through Our Work, Knowledge Grows *
> 
> 
> 
> 
> 
> _______________________________________________
> 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


More information about the OPEN-ILS-DOCUMENTATION mailing list