Requirements for default publication II

--=-=-=


Hi

I consolidated the requirements again and added some of the input from
the discussion on the mailing list.

Basically the following points are still contentious:

1. Doctype: should we have a XHTML doctype? Felix argues that the
   world wants it whereas Andreas doesn't like it for it's impurity.

2. Doctype: The simple doctype that we want to use. Is it the Forrest
   document type or some simple home-grown DTD? Felix prefers the
   custom home-grown version.

3. sitetree framework: Do we roll our own? Do we use the Forrest
   mechanism? Do we allow for browser-based editing of the navigation?
   Do we integrate work-flow?

Attached is an updated version of the requirements.


--=-=-=
Content-Disposition: attachment; filename=DefaultPubRequirements.txt
Content-Description: Requirements for default publication

====================================
Requirements for Default publication
====================================

Motivation
----------

We want to create a default publication for Lenya that

- can be looked at by a beginner who wants to learn how Lenya works
- can be used by us to implement new concepts and best practices like
  sitetree/navigation framework, standard URI space, page envelope,
  menu framework.
- provides an "out of the box" publication that can be easily adapted
  and used
- the intent of the default publication is not to *completely*
  understand all the intricacies of the publication but to learn how
  to extend and adapt it to fit your needs.

Purpose
-------
1. best practice showcase (exploring for us and learning for others)
2. low entry barrier (immediate value after download)

Document URI space
------------------
- No predefined URI space
- No URI-doctype mapping
- URIs can be chosen by the user arbitrarily

Site structure
--------------
- A node can be created anywhere
- Arbitrary mixture of doctypes

Doctypes
--------
- Two doctypes (as few as possible): simple content doctype and XHTML
  doctype
- No collection doctype (just navigation)
- Homepage: simple content doctype

Simple content doctype
----------------------
- Editable by Xopus and Bitflux
Elements:
- Page Heading
- Subtitle
- Lead
- Paragraph
- Section heading
- List
- List item
- Table
- Table row
- Table cell
- Image
- Image caption

XHTML doctype
-------------

- Upload function for XHTML file (including tidy resp. check for
  well-formedness)
- Body part of XHTML is extracted and inserted into the content area
  of the page
- Check-in upon upload
- Download function with check-out
- Editable with Xopus?

Navigation
----------
- Navigation is built automatically
- Navigation folding (static)
- Highlighting of current location
- Order of nodes in navigation can be edited
- separate navigation from URI structure (?)

Components
----------
- Access Controller
- Publisher
- Creator
- Revision Controller
- Scheduler
- Site Tree Manager
- Navigation Framework
- File Upload
- Search Engine

Images
------
- Red dots
- Upload through file upload
- Upload screen: caption, no identifier
- Images on XHTML pages?

Menu
----
- File
   New content page
   New XHTML page
   Publish
   Schedule
   (Delete)
   Logout

- Edit (for simple content doctype)
   Edit with Bitflux
   Edit with Xopus
   (Edit XML)

- Edit (for XHTML doctype)
   Upload XHTML document
   Download XHTML download
   (Edit XML)

- Tools
   Scheduler Admin
   Rollback
   Create Search Index

- Help
   About this publication
   Lenya documentation
   About Lenya

Nice to have
------------
- GUI user administration (as soon as we have it)

--=-=-=


-- 
Christian Egli       [email protected]   +41 1 272 9161
                     Wyona AG, Hardstrasse 219, CH-8005 Zurich
Open Source CMS      http://www.wyona.org http://www.wyona.com 

--=-=-=--