Commit 451b6307 authored by Jérome Perrin's avatar Jérome Perrin

- typos

- specify in IMetadataDiscoverable.getContentInformation that the return type
  is a dictionnary


git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@30028 20353a03-c40f-0410-a6d1-a30d3c3de9de
parent c9e9d388
...@@ -41,7 +41,7 @@ class ICrawlable(Interface): ...@@ -41,7 +41,7 @@ class ICrawlable(Interface):
def crawlContent(): def crawlContent():
""" """
Initialises the crawling process from the current document. Initialises the crawling process from the current document.
The crawling process is delegate to an ERP5 crawler such The crawling process is delegated to an ERP5 crawler such
as the ContributionTool. as the ContributionTool.
""" """
......
...@@ -31,7 +31,7 @@ from zope.interface import Interface ...@@ -31,7 +31,7 @@ from zope.interface import Interface
class IGranulatable(Interface): class IGranulatable(Interface):
""" """
Convertable interface specification Granulatable interface specification
Documents which implement IGranulatable can be analysed Documents which implement IGranulatable can be analysed
and granulated into smaller sub documents. Reversely, and granulated into smaller sub documents. Reversely,
...@@ -53,4 +53,4 @@ class IGranulatable(Interface): ...@@ -53,4 +53,4 @@ class IGranulatable(Interface):
Updated the current document by assembling subcontent Updated the current document by assembling subcontent
and generate a new document. It is the reverse method and generate a new document. It is the reverse method
of IGranulatable.granulateContent of IGranulatable.granulateContent
""" """
\ No newline at end of file
...@@ -33,16 +33,16 @@ class IMetadataDiscoverable(Interface): ...@@ -33,16 +33,16 @@ class IMetadataDiscoverable(Interface):
""" """
Metadata Discoverable interface specification Metadata Discoverable interface specification
Documents which implement IMetadataDiscoverable provide Documents which implement IMetadataDiscoverable provides
methods to discover and update metadata properties methods to discover and update metadata properties
from content, user input, file name, etc. from content, user input, file name, etc.
""" """
def getContentInformation(): def getContentInformation():
""" """
Returns all possible metadata which can be extracted Returns a dictionnary of possible metadata which can be extracted from the
from the document content (ex. title from an HTML file, document content (ex. title from an HTML file, creation date from a PDF
creation date from a PDF document, etc.) document, etc.)
""" """
def getPropertyDictFromUserLogin(user_login=None): def getPropertyDictFromUserLogin(user_login=None):
...@@ -55,7 +55,7 @@ class IMetadataDiscoverable(Interface): ...@@ -55,7 +55,7 @@ class IMetadataDiscoverable(Interface):
def getPropertyDictFromContent(): def getPropertyDictFromContent():
""" """
Base on the result of getContentInformation, find out all Based on the result of getContentInformation, find out all
properties which can be discovered to later update document metadata. properties which can be discovered to later update document metadata.
""" """
...@@ -94,4 +94,4 @@ class IMetadataDiscoverable(Interface): ...@@ -94,4 +94,4 @@ class IMetadataDiscoverable(Interface):
no reference was defined.) no reference was defined.)
XXX - it is unclear if this method should be part of the interface XXX - it is unclear if this method should be part of the interface
""" """
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment