Ferenda
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
Customizing the table(s) of content
Defining criteria 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 used
The REST(ish) API
Setting up external databases
Triple stores
Fulltext search engines
Advanced topics
Composite docrepos
Patch files
External annotations
Keyword hubs
The
DocumentRepository
class
The
Document
class
The
DocumentEntry
class
The
DocumentStore
class
The
TocCriteria
class
The
TocPage
class
The
TocPageset
class
The
NewsCriteria
class
The
LayeredConfig
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
Datatype field classes
Search field classes
The
TextReader
class
The
PDFReader
class
The
WordReader
class
The
util
module
The
citationpatterns
module
The
uriformats
module
The
manager
module
The
testutil
module
Decorators
Errors
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
Ferenda
Docs
»
ferenda.sources.tech
– repositories for technical standards
Edit on GitHub
ferenda.sources.tech
– repositories for technical standards
¶
W3Standards
¶
class
ferenda.sources.tech.
W3Standards
(
**kwargs
)
¶
RFC
¶
class
ferenda.sources.tech.
RFC
(
**kwargs
)
¶
Read the Docs
v: v0.1.7
Versions
latest
v0.1.7
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.