Ferenda

Ferenda is a python library and framework for transforming unstructured document collections into structured Linked Data. It helps with downloading documents, parsing them to add explicit semantic structure and RDF-based metadata, finding relationships between documents, and republishing the results.

• Introduction to Ferenda
  • Example
  • Prerequisites
  • Installing
  • Features
  • Next step
• First steps
  • Creating a Document repository class
  • Using ferenda-build.py and registering docrepo classes
  • Downloading
  • Parsing
  • Republishing the parsed content
• Creating your own document repositories
  • Writing your own download implementation
  • Writing your own parse implementation
  • Calling relate()
  • Calling makeresources()
  • Customizing generate()
  • Customizing toc()
  • Customizing news()
  • Customizing frontpage()
  • Next steps
• Key concepts
  • Project
  • Configuration
  • DocumentRepository
  • Document
  • Identifiers
  • DocumentEntry
  • File storage
• Parsing and representing document metadata
  • Document URI
  • Adding metadata using the RDFLib API
  • A simpler way of adding metadata
  • Vocabularies
  • Serialization of metadata
  • Metadata about parts of the document
• Building structured documents
  • Creating your own element classes
  • Mixin classes
  • Rendering to XHTML
  • Convenience methods
• Parsing document structure
  • FSMParser
  • A simple example
  • Writing complex parsers
  • Tips for debugging your parser
• Citation parsing
  • The built-in solution
  • Extending the built-in support
  • Rolling your own
• Reading files in various formats
  • Reading plain text files
  • Microsoft Word documents
  • PDF documents
• Grouping documents with facets
  • Applying facets
  • Selectors and identificators
  • Contexts where facets are used
  • Grouping a document in several groups
  • Combining facets from different docrepos
• Customizing the table(s) of content
  • Defining facets for grouping and sorting
  • Getting information about all documents
  • Making the TOC pages
  • The first page
• Customizing the news feeds
• The WSGI app
  • Running the web application
  • URLs for retrieving resources
• The ReST API for querying
  • Free text queries
  • Result lists
  • Parameters
  • Paging
  • Statistics
  • Ranges
  • Support resources
  • Legacy mode
• Setting up external databases
  • Triple stores
  • Fulltext search engines
• Testing your docrepo
  • Extra assert methods
  • Creating parametric tests
  • RepoTester
  • Download tests
  • Distill and parse tests
  • Py23DocChecker
  • testparser
• Advanced topics
  • Composite docrepos
  • Patch files
  • External annotations
  • Keyword hubs
  • Custom common data
  • Custom ontologies
  • Parallel processing

API reference

Classes

• The DocumentRepository class
• The Document class
• The DocumentEntry class
• The DocumentStore class
• The Facet class
• The TocPage class
• The TocPageset class
• The Feed class
• The Feedset class
• The elements classes
• The elements.html classes
• The Describer class
• The Transformer class
• The FSMParser class
• The CitationParser class
• The URIFormatter class
• The TripleStore class
• The FulltextIndex class
• The TextReader class
• The PDFReader class
• The PDFAnalyzer class
• The WordReader class

Modules

• The util module
• The citationpatterns module
• The uriformats module
• The manager module
• The testutil module

Decorators

• Decorators

Errors

• Errors

Document repositories

• ferenda.sources.general.Static – generate documents from your own .rst files
• ferenda.sources.general.Keyword – generate documents for keywords used by document in other docrepos
• ferenda.sources.general.MediaWiki – pull in commentary on documents and keywords from a MediaWiki instance
• ferenda.sources.general.Skeleton – generate skeleton documents for references from other documents
• ferenda.sources.tech – repositories for technical standards
  • W3Standards
  • RFC
• ferenda.sources.legal.eu – repositories for EU law
  • EurlexTreaties
  • EurlexCaselaw
• ferenda.sources.legal.se – repositories for Swedish law
  • ARN
  • Direktiv
  • Ds
  • DV
  • JK
  • JO
  • Kommitte
  • MyndFskr
  • Propositioner
  • SFS
• The Devel class

Changes

• 0.3.0 (released 2015-02-18)
• 0.2.0 (released 2014-07-23)
• 0.1.7 (released 2014-04-22)
• 0.1.6.1 (released 2013-11-13)
• 0.1.6 (released 2013-11-13)
• 0.1.5 (released 2013-09-29)
• 0.1.4 (released 2013-08-26)
• 0.1.3 (released 2013-08-11)
• 0.1.2 (released 2013-08-02)
• 0.1.1 (released 2013-07-27)
• 0.1.0 (released 2013-07-26)

Indices and tables

• Index
• Module Index
• Search Page