Invenio documentation¶
Welcome to Invenio’s documentation. This documentation is divided into different parts. We recommend that you get started with First Steps with Invenio and then head over to the Quickstart. Besides the quickstart, there is also a more detailed Tutorial that shows how to create a complete application with Invenio. If you’d rather dive into the internals of Invenio, check out the API documentation. Common patterns are described in the Patterns section.
Invenio depends on several external libraries:
- the Flask microframework for Python (based on Werkzeug and Jinja2),
- the Jinja2 template engine,
- the Werkzeug WSGI toolkit,
- the SQLAlchemy SQL toolkit and Object Relational Mapper.
These libraries are not documented here. If you want to dive into their documentation, check out the following links:
Getting Started¶
This part of the documentation, which is mostly prose, begins with some background information about Invenio, then focuses on step-by-step instructions for customization of Invenio.
Developer’s Guide¶
The Invenio Developers’ corner. Before diving into the source, make sure you don’t miss our user-level and admin-level documentation as well. And now, back to the source, and happy hacking!
Admins’s Guide¶
- Admin’s Guide
- BibAuthority Admin Guide
- BibClassify Admin Guide
- BibConvert Admin Guide
- A. Overview
- B. XML-Oriented Mode
- C. Plain Text-Oriented Mode
- 1. Configuration File Examples
- 2. Running BibConvert
- 3. BibConvert Configuration Guide
- Conventions
- 3.1 Step 1 Definition of Source record
- 3.2 Step 2 Definition of Source fields
- 3.3 Step 3 Definition of target record
- 3.4 Formatting in BibConvert
- ADD(prefix,postfix)
- KB(kb_file) - kb_file search
- ABR(x,trm),ABRW(x,trm) - abbreviate term to x places with(out) postfix
- ABRX() - abbreviate exclusively words longer than given limit
- CUT(prefix,postfix) - remove substring from side
- REP(x,y) - replace x with y
- SUP(type,string) - suppress chars of certain type
- LIM(n,side)/LIMW(str,side) - limit to n letters while trimming L/R side
- WORDS(n,side) - limit to n words while trimming L/R side
- MINL(n) - exp. words shorter than n
- MAXL(n) - exp. words longer than n
- MINLW(n) - replacement of short values
- EXP(str,1|0) - exp./aprove word containing specified string
- EXPW(type) - exp. word from value if containing spec. type
- IF(value,valueT,valueF) - replace T/F value
- UP - upper case
- DOWN - lower case
- CAP - make capitals
- SHAPE - format string
- NUM - number
- SPLIT(n,h,str,from)
- SPLITW(sep,h,str,from)
- CONF(field,value,1/0) - confirm validity of a field
- CONFL(str,1|0) - confirm validity of a field
- RANGE(from,to) - confirm only entries in the specified range
- DEFP() - default print
- IFDEFP(field,value,1/0) - IF condition is met, default print
- JOINMULTILINES(prefix,suffix) - Join a multiline string into a single line with each segment having prefix and suffix
- 3.4.2 Generated values
- DATE(format,n)
- WEEK(diff)
- SYSNO
- OAI
- BibEdit Admin Guide
- BibKnowledge Admin Guide
- BibMatch Admin Guide
- BibSched Admin Guide
- BibUpload Admin Guide
- 1. Overview
- 2. Configuring BibUpload
- 3. Running BibUpload
- 4. Batch Uploader
- DocExtract Admin Guide
- OAIHarvest Admin Guide
- OAIRepository Admin Guide
- Publiline Admin Guide
- WebMessage Admin Guide
- WebSession Admin Guide
- WebStyle Admin Guide
API Reference¶
If you are looking for information on a specific function, class or method, this part of the documentation is for you.
Community¶
Additional Notes¶
Design notes, legal information and changelog are here for the interested.