Navigation
About
Contribute
Follow
others

Documentation

From Self Shelf Swap Community Wiki
Jump to: navigation, search

This is the technical documentation for Developpers made from the modules with Perl Pod. Technical explanations from our 0.0.1 version can be a good introduction.

P.S.: if you are a librarian, do not try to read this...

Contents

Install

First, you need to setup the environment.

Perl Modules Doc

The Microlibrary

Common things about the app and the way of using it - Documentation:Microlibrary

Data

CURL

Build and send requests to the Open Library API - Documentation:CurlRequester

Cover

Manage covers from Open Library API - Documentation:CoverTool

Properties

Read key-values peers into a file - Documentation:Properties

RDF

Manipulates RDF fluxus or files. Le coeur de la meule.

This is the swiss army knife for our RDF flux and files. We can easyly parse RDF flux, store it into files, and get many elements into this flux. We can also retrieve data from the files and use it for displaying the items of our library.

Documentation:RDFTool

Maps

View

Microlibrary renderer for repetitive print stuffs - Documentation:WebDisplayer

How To Documentation

A hardwork has been made to give you a decent useful documentation. It is directly included into the Perl modules, with the POD way (Plain Old Documentation) but is also exported here (sometimes). The better way to read the most up-to-date documentation is to download the sources, Perl and install the shurfist environment on your computer and do this :

How to read POD

$ cd [to-the-place-where-you-download-the-stuff]
$ cd lib/
$ perldoc microlibrary.pl


It will display a very user-friendly man-style documentation :

MICROLIBRARY(1)        User Contributed Perl Documentation        MICROLIBRARY(1)
 
 
 
NAME The Microlibrary mimicrokernel
DESCRIPTION
       This script runs a web-service thru the Open Library (OL) API, stores data
       send by the web-service into files and generate XHTML to display data in a
       very simple page.  The microlibrary is made to manage everything to
       generate a book-shelf page, using your data from Open Library. For more
       informations and How To, please see http://goo.gl/k375R
 
   The Self Shelf Swap Project
       This first implementation is a physical object (books) swaping/sharing
       system.  Our Library project is to create an online index which could make
       (in next version) possible to :
 
       Inform
           retrieve informations about registered documents
 
       Locate
           know where documents are physically based and if you can loan it )
 
       Create
           register an account & create your own Library DataBase
 
       Share
           share it with other users.
 
       Our desire is to provide a private Libraries Network in an IRL spirit, a
       Library of Libraries ("meta-libraries"), physically based (shelfs).  We
       don't want to provide downloadable documents.
 
       That's why our project is named "Self Shelf Swap". It's first
       implementation will be Bibliothek.
 
   How does-it do the job ?
       The lists
           List are considered like thematic shelfes of your library.  First the
           microlibrary mimicrokernel calls the Properties Reader, that will
           parse our open_library_lists file, and return an array if list ids.
           This array is passed as an argument to the build_the_list_request()
           subroutine of the Curl Requester, that will build and get the list
           requests. For each list id, we get a RDF flux containing books URI.
           Flux are stored into your hard drive by passing the RDF flux, the list
           id and the "list" flag (to specify that we manage lists) to the
           store_RDF_flux() of the RDF Tool.
 
       The books
           Next, for each list, we load the file on disk thru the
           parse_RDF_file() subroutine, passing the list id as an argument. We
           get many data thru the get_list_element() subroutine of RDFTool, that
           will get all books data. For more information about this part, see the
           RDFTool documentation.
 
       The View
           The Web Displayer was and is still scattered everywhere. And will be
           remplaced soon by a more decent system (AKA MVC). Now, at 0.02 version
...


Generate documentation from POD

To generate the wiki markup documentation from POD inside Perl modules documentation, we use this simple command:

pod2wiki -s mediawiki microlibrary.pl microlibrary_mediawiki.wiki
.
Personal tools