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

Extend interfaces (for future documentation).

Location:
main/waeup.ikoba/trunk/src/waeup/ikoba/documents
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • main/waeup.ikoba/trunk/src/waeup/ikoba/documents/document.py

    r12444 r13135  
    233233    """A file id chooser for :class:`Document` objects.
    234234
    235     `context` is an :class:`Document` instance.
     235    `context` is a :class:`Document` instance.
    236236
    237237    The delivered file_id contains the file id marker for
     
    267267        *Example:*
    268268
    269         For document with id 'd123'
    270         with attr ``'nice_image.jpeg'`` this chooser would create:
    271 
    272           ``'__file-document__nice_image_d123.jpeg'``
     269        For document with id ``d123`` and
     270        with attr ``nice_image.jpeg`` this chooser would create:
     271
     272          ``__file-document__nice_image_d123.jpeg``
    273273
    274274        meaning that the nice image of this document would be
  • main/waeup.ikoba/trunk/src/waeup/ikoba/documents/export.py

    r12410 r13135  
    4646                  'translated_class_name',
    4747                  'connected_files',   # Could be used to export file URLs
     48                  'form_fields_interface',
     49                  'filenames',
     50                  'local_roles',
    4851                  ]
    4952            ))) + (
  • main/waeup.ikoba/trunk/src/waeup/ikoba/documents/interfaces.py

    r12408 r13135  
    2626class IDocumentsContainer(IIkobaObject):
    2727    """A container for all kind of document objects.
    28 
    2928    """
    3029
     
    3635class IDocument(IIkobaObject):
    3736    """A base representation of documents.
    38 
    3937    """
    4038    history = Attribute('Object history, a list of messages')
    41     state = Attribute('Returns the verification state of a document')
    42     translated_state = Attribute(
    43         'Returns a translated, more verbose verification state of a document')
     39    state = Attribute('Workflow state of a document')
     40    translated_state = Attribute('Translatable workflow state of a document')
    4441    class_name = Attribute('Name of the document class')
    45     translated_class_name = Attribute('Translatable class name')
    46     formatted_transition_date = Attribute('Last transition formatted date string')
     42    translated_class_name = Attribute('Translatable class name of a document')
     43    formatted_transition_date = Attribute(
     44        'Last transition formatted date string')
     45    form_fields_interface = Attribute(
     46        'Interface which is used in forms for grok.AutoFields')
     47    local_roles = Attribute('List of local role names')
    4748    user_id = Attribute('Id of a user')
    4849    connected_files = Attribute('Names of files connected to a document')
    49     is_verifiable = Attribute('Contract verifiable by officer')
     50    is_verifiable = Attribute('True if contract verifiable by officer')
    5051
    5152    document_id = schema.TextLine(
     
    6768class IPublicDocument(IDocument):
    6869    """A base representation of public documents.
    69 
    7070    """
    7171
     
    8383class IPDFDocument(IPublicDocument):
    8484    """A base representation of PDF documents.
    85 
    8685    """
    8786
     87    filenames = Attribute('Tuple of filenames; only one filename recommended')
    8888
    8989class IHTMLDocument(IPublicDocument):
     
    9292    """
    9393
    94     html_dict = Attribute('Content as language dictionary with values in HTML format')
     94    html_dict = Attribute(
     95        'Content as language dictionary with values in HTML format')
    9596
    9697    html_multilingual = schema.Text(
     
    101102class IRESTDocument(IPublicDocument):
    102103    """A base representation of REST documents.
    103 
    104104    """
    105105
     
    115115class IDocumentsUtils(Interface):
    116116    """A collection of methods which are subject to customization.
    117 
    118117    """
    119118
Note: See TracChangeset for help on using the changeset viewer.