Changeset 13136 for main/waeup.kofa/trunk/docs

Timestamp:

3 Jul 2015, 10:24:37 (9 years ago)

Author:

Henrik Bettermann

Message:

More docs.

File:

• main/waeup.kofa/trunk/docs/source/userdocs/documents.rst (modified) (1 diff)

main/waeup.kofa/trunk/docs/source/userdocs/documents.rst

@@ -3 +3 @@
 Public Documents :sup:`in progress`
 ***********************************
+
+The 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.
+
+Technically 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::
+
+  Public Documents (DocumentsContainer)
+  |
+  +---> PDFDocument
+  |
+  +---> HTMLDocument
+  |
+  +---> RESTDocument
+
+The 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.
+
+Interfaces
+==========
+
+The 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.
+
+.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
+   :pyobject: IDocument
+
+.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
+   :pyobject: IPublicDocument
+
+A PDF Document further specifies which pdf files are connected to the object. Usually, only one filename is in the `filenames` tuple.
+
+.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
+   :pyobject: IPDFDocument
+
+HTML 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.
+
+.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
+   :pyobject: IHTMLDocument
+
+.. literalinclude:: ../../../src/waeup/kofa/documents/interfaces.py
+   :pyobject: IRESTDocument
+
+
+Workflow & History
+==================
+
+Browser Pages
+=============
+
+Data Export
+===========
+
+Data Import
+===========
+
+Logging
+=======
+
+
+
+
+