Changeset 13136


Ignore:
Timestamp:
3 Jul 2015, 10:24:37 (9 years ago)
Author:
Henrik Bettermann
Message:

More docs.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • main/waeup.kofa/trunk/docs/source/userdocs/documents.rst

    r12908 r13136  
    33Public Documents :sup:`in progress`
    44***********************************
     5
     6The documents section of Kofa is a tiny built-in content management system (CMS), which has been developed mainly for publishing announcements, adverts, instructions or general information provided by the university to inform prospective students about application and registration procedures.
     7
     8Technically speaking, the documents section is a container of type `DocumentsContainer` with id ``documents``, which is located in the `IUniversity` instance and which contains documents. There are three types of public documents::
     9
     10  Public Documents (DocumentsContainer)
     11  |
     12  +---> PDFDocument
     13  |
     14  +---> HTMLDocument
     15  |
     16  +---> RESTDocument
     17
     18The first can be used to provide pdf files for download. The second and third can be used to create multilingual static html pages on the portal. HTML documents expect html coded text as input, REST documents expect reStructuredText which is transformed into html. Public documents have a publication workflow with two states: created and published. Only published documents can be seen by anonymous users.
     19
     20Interfaces
     21==========
     22
     23The base for all three document interfaces is `IPublicDocument` which inherits from `IDocument`. All attributes are read-only properties, i.e. attributes with a getter method only. These properties are computed dynamically and can't be set. Only the document id and the title can be entered on form pages or imported.
     24
     25.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
     26   :pyobject: IDocument
     27
     28.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
     29   :pyobject: IPublicDocument
     30
     31A PDF Document further specifies which pdf files are connected to the object. Usually, only one filename is in the `filenames` tuple.
     32
     33.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
     34   :pyobject: IPDFDocument
     35
     36HTML and REST documents have schema field for multi-lingual content in HTML or in REST format respectively, see :ref:`note <multilingual>`. The hidden `html_dict` attributes contain the same information, but the sequence of language translations has been split up and copied into a dictionary for faster processing.
     37
     38.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
     39   :pyobject: IHTMLDocument
     40
     41.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
     42   :pyobject: IRESTDocument
     43
     44
     45Workflow & History
     46==================
     47
     48Browser Pages
     49=============
     50
     51Data Export
     52===========
     53
     54Data Import
     55===========
     56
     57Logging
     58=======
     59
     60
     61
     62
     63
Note: See TracChangeset for help on using the changeset viewer.