Information

Created in: 2006-01-07 12:48:34

Author: martin

Size: 6549 bytes

Last updated: 2006-01-07 12:48:34

Categories

Documents & Articles

You may be interested in...

Working with documents

Updating a document

Adding multiple documents and directories

Tutorial: Adding a document to the repository

jLibrary document structure is very similar to the typical file-based structure. The two basic units of any repository are directories and documents. Directories, are folder where information will be stored. Documents, represent any media type stored on the repository, from text files to multimedia video. Finally there is another entity, also important: resources. Resources are files that a document needs to be displayed correctly like can be images, css stylesheets, scripts, etc.

Before starting with the tutorial, you should have in mind that to create documents you must have write permissions on the repository. In case that you don't have such permissions, you'll get an error message. If that happens, you should contact with your jLibrary server admin to ask him for write permissions.

Directory creation is a very easy task. Simply you have to right click over the repository in which you want to create the document, or over another directory, and choose the menu option New -> Create new directory

Once you have done it, it will appear a new directory wizard that will ask you for the name and description of the repository. Enter directory data and press Accept to continue.

The repository is already created . To create a document within this directory, right click over it and select the menu option New -> Create new document.

When you have selected that option, it will appear the document creation wizard. This wizard has four sections: document data loading, resources loading, metadata loading and categories loading. The first one is the document loading page:

The first thing you must do is press the document loading button. This button will show a file selection dialog. Select the document you want to load and press Open. One you have done this, jLibrary will try to obtain document metadata automatically. This operation can take some seconds if the file is too big ( for example a PDF book ), because jLibrary analyzes file header and content searching for the most appropiate data and keywords.

In the case of jLibrary not being able to get metadata, or if jLibrary founds wrong metadata, you'll have to enter manually the name and description for the document. You can also modify the importancy of the document. One important document would have preference at the time of performing searchs.

The second page is the resources one:

In this page you can add files from which the document depends for its correct visualization or operation. This files can be video files, audio files, text documents, etc. One typical example of such dependencies would be a web pages with images, css stylesheets or JavaScript files. From this page, you can also add complete resouces directories. Also, if the document you have loaded is a jLibrary known type, then the system will try to load resource dependencias automatically. For example, if you are loading an HTML file, jLibrary will fill this list with all the images that the file uses.

The third page is about document metadata:

In this page you can enter document metadata. This metadata offer additional information about the document. This information will be specially useful at the time of search operations. If jLibrary recognizes the document format, it will try to automatically extract the metadat from document header. If the document doesn't have such metadata, you'll have to enter this metadata manually.

jLibrary also analyzes automatically the document content to search for the most appropiate keywords. If this keywords aren't useful for you, you can manually substitute them for others. Currently the keyword search algorithm is really simple (only occurrences count), so if you want a better algorithm, then you could contributewith one :-)

jLibrary also includes an authors management module. If jLibrary doesn't recognize the author of a document, it will assing the Unknown author to the document. Pressing the author management button, you can create new authors, and assign an author to the document.

 

The last page is the categories one:

This page allows adding the document to different categories. By default, the document is classified under Unknown category. If you wish to add the document to another category, you can press the plus button. If you wish to remove the document from any category, you can select that category and press the minus button.

Once that you have entered all document data, you can press Finish button to create the document. If that button isn't enabled, then you have forgotten to enter some important mandatory data. In such cases, an informative message should be shown in the wizard's top, telling you which is the missing data.

You can see on the screenshot above, how jLibrary have created the document and have added all the provided document resources. Document resources, appear on the jLibrary repository tree with an special drawing at the icon right-bottom.

Congratulations ! You have created your first document :)

-martin