From: Art Rhyno Date: Fri, 8 Jul 2011 03:03:57 +0000 (-0400) Subject: Start of documentation in asciidoc. X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=571581ff0f7f2e7f743cef8f9cbcb65aed49ff5c;p=syrup%2Fmasslnc.git Start of documentation in asciidoc. Signed-off-by: Art Rhyno --- diff --git a/docs/images/admin.jpg b/docs/images/admin.jpg new file mode 100755 index 0000000..04c35c3 Binary files /dev/null and b/docs/images/admin.jpg differ diff --git a/docs/images/desk_example.jpg b/docs/images/desk_example.jpg new file mode 100755 index 0000000..6b031c2 Binary files /dev/null and b/docs/images/desk_example.jpg differ diff --git a/docs/images/desk_menu.jpg b/docs/images/desk_menu.jpg new file mode 100755 index 0000000..28683cd Binary files /dev/null and b/docs/images/desk_menu.jpg differ diff --git a/docs/images/term_example.jpg b/docs/images/term_example.jpg new file mode 100755 index 0000000..5890be1 Binary files /dev/null and b/docs/images/term_example.jpg differ diff --git a/docs/images/term_menu.jpg b/docs/images/term_menu.jpg new file mode 100755 index 0000000..e672f79 Binary files /dev/null and b/docs/images/term_menu.jpg differ diff --git a/docs/syrup.html b/docs/syrup.html new file mode 100644 index 0000000..6d308a2 --- /dev/null +++ b/docs/syrup.html @@ -0,0 +1,4366 @@ + + + + + +Syrup User Guide + + + + + +
+
+
+

The install instructions in the README are the most up to date. These are +in the Syrup/conifer directory if you use git to get the application.

+
+
+
git clone git://git.evergreen-ils.org/Syrup.git
+
+

This document assumes you have Syrup running and walks through configuring a +working instance.

+
+
+
Why Syrup?
+

It is a little unclear. It might have been an acronym for Serving Your +Reserves to University Populations. The project originated within +Project Conifer and pays homage to the library +world’s most ambitious open source undertaking (otherwise known as +Evergreen).

+
+
+
+

1. Initial Configuration

+
+

Syrup needs time periods for controlling when course sites are to be made +available. After you log in the first time, the first stopping point should +probably be the Admin link.

+

+Admin Link +

+

We use Terms to define the period for which course materials will be active.

+

+Admin Menu +

+

You can define as many terms as you want but you need at least one to add +materials to Syrup. In this case, we will define one for the summer.

+

+Term Example +

+

You also need at least one Service Desk if you intend to offer physical +materials for reserves.

+

+Service Desk Menu Option +

+

A service desk in Syrup is really just a helpful cue to the user where to +request materials. The name does not have to match the wording in your ILS +or elsewhere. The service desk can also be given a URL-friendly name for +linking.

+

+Service Desk Menu Option +

+
+
+
+ + + diff --git a/docs/syrup.txt b/docs/syrup.txt new file mode 100644 index 0000000..0876b04 --- /dev/null +++ b/docs/syrup.txt @@ -0,0 +1,54 @@ +Syrup User Guide +================ +Art Rhyno +:Author Initials: AR +:toc: +:icons: +:numbered: +:website: http://git.evergreen-ils.org/?p=Syrup.git;a=summary + +The install instructions in the README are the most up to date. These are +in the 'Syrup/conifer' directory if you use git to get the application. + + git clone git://git.evergreen-ils.org/Syrup.git + +This document assumes you have Syrup running and walks through configuring a +working instance. + +.Why Syrup? +********************************************************************** +It is a little unclear. It might have been an acronym for 'Serving Your +Reserves to University Populations'. The project originated within +http://projectconifer.ca/[Project Conifer] and pays homage to the library +world's most ambitious open source undertaking (otherwise known as +http://www.open-ils.org/[Evergreen]). +********************************************************************** + +Initial Configuration +--------------------- +Syrup needs time periods for controlling when course sites are to be made +available. After you log in the first time, the first stopping point should +probably be the 'Admin' link. + +image:images/admin.jpg[Admin Link] + +We use 'Terms' to define the period for which course materials will be 'active'. + +image:images/term_menu.jpg[Admin Menu] + +You can define as many terms as you want but you need at least one to add +materials to Syrup. In this case, we will define one for the summer. + +image:images/term_example.jpg[Term Example] + +You also need at least one 'Service Desk' if you intend to offer physical +materials for reserves. + +image:images/desk_menu.jpg[Service Desk Menu Option] + +A service desk in Syrup is really just a helpful cue to the user where to +request materials. The name does not have to match the wording in your ILS +or elsewhere. The service desk can also be given a URL-friendly name for +linking. + +image:images/desk_example.jpg[Service Desk Menu Option]