Tutorial

This tutorial gives you a short introduction into the Apache Lenya content management system. We'll look at a typical use case where we create a new document, edit and publish it.

Creating a new document

To create a new document goto the File->New Document menu entry. You'll get a new screen that asks you for an id and a name for this new document. The id will be used internally as an identifier for the document and the name will be used in the navigation. Let's use "foo" as id and "Foo" as the name of the new document. Now press Create. You will be redirected back to the page where you originally invoked the creation and you'll notice that the new document "Foo" now shows up as a sub-document of the Tutorial document in the navigation.

This illustrates the fact that a new document is always created as a sub-document of the document you're currently looking at. You also notice how the navigation is built automatically.

Editing a document

To look at the newly created document click on the "Foo" entry in the navigation. You'll notice that the "Foo" document already contains some content. It was created from a sample XML document. To change this sample content you will have to edit the document. You can pick on of the following web-based WYSIWYG editors:

Pick your choice of editor (based on your platform) and start editing the newly created document by selecting the Edit->Edit with BXE menu button. The Lenya menu will disappear and the Bitflux toolbar will appear instead. You can use the left mouse button to get a context sensitive menu from where you can copy, cut and paste. You're also able to insert new elements into the document from the context sensitive menu. Once you're done with all your changes, press Save&Exit to get back. You'll see your changes in the document.

Lenya Meta Data

The LenyaMetaDataGenerator lets you receive the metada for any given document. In this pub there is an example in the sitemap.xmap (pattern="meta") it only should demonstrate one possible usage (you would need to edit this match for your own use case). See the meta data from this page with meta?docid=/tutorial&lang=en.

Publishing a document

Once you are satisfied with the content of the document you want to publish it to make it visible in the live area.

Workflow

The default publication has a simple workflow configured which involves an author and a reviewer. The author creates and edits a new document and submits it for approval. The reviewer (obviously :-)) reviews the document and publishes it so that it will appear on the live site. The user lenya (which you are probably currently logged in as) has the role edit, i.e. he can create new documents and submit them for approval (with Workflow->Submit for review). The user alice has the role review which allows her to approve, i.e. publish documents.

In order to publish your newly created document simply press Workflow->Sumbit (as user lenya) to submit the current document for approval. Now log out (File->Logout), log back in as alice (use the same password as for user lenya) and publish the current document by selecting Workflow->Publish. You will get a confirmation screen where you confirm your intention to publish the document "Foo" by pressing Publish Now. You might have to publish the parent document ("Tutorial") first, as the "Foo" document will not be published if the parent document is not in the live area yet.

To check how the "Foo" document looks like in the live site click on the live tab in the Lenya menu. This will open a new browser window showing you the live site.

Scheduling

Apache Lenya allows you to publish a document at a specific date. To do this select the Workflow->Publish menu entry. Now instead of pressing Publish, specify the date and the time at which you wish to publish the document and press Schedule. Your document will be published at the specified date. Use the Scheduler tab in the site area to see the pending tasks and their status.

Revision Control

Every time you edit a document and exit the editor a new revision of the document is stored. Old versions of the document are kept and you can go back to an older version if you want to undo some of the changes you applied to it. To see all available versions of the current document press Tools->Rollback. This will give you a list of all previous versions. You can view a specific old version or rollback to a specific old version by clicking on the appropriate links.