Invenio
Getting Started
Introduction to Invenio
What is a Registry?
What do I need?
Get Started
Quickstart
Demo and Example Sites
Demo Sites
Production Sites
Features
Navigable collection tree
Powerful search engine
Flexible metadata
User personalization
Multiple output formats
First Steps with Invenio
1. About
2. Prerequisites
2.1. Debian / Ubuntu LTS
2.2. Centos / RHEL
2.3. OS X
2.4. Extra tools
3. Quick instructions for the impatient Invenio developer
3.1. Installation
3.2. Configuration
3.3. Development
4. Final words
How to create an Invenio overlay
What is an overlay
Creating your first Invenio overlay
The global setup
The virtual environment
The base of the overlay
Configuration
Sensitive configuration
Database setup
Assets
Running
Translations
Configuration
Message Extraction
Create Catalog for New Language
Compiling Catalog
Updating Strings
Deployment
Prerequisites
Preparing the tarball
Creating the virtual environement
Installing the package
Configuration
Running the server
Dealing with versions
Common Concepts
Developer’s Guide
Introducing Invenio for Developers
Extensions
Modules
Extensions
Plugging an Existing Extension
Code structure
Pluggable Objects
Models
Code structure
Quering
Subqueries
Schema
Improve code readability
Modules
Views
How to develop a module: Part 1
Overview
How to develop a module: Part 2
Multiple views
Module-wide configuration
How to develop a module: Part 3
Tests
Documentation
Templates
Tutorial
Git Workflow
Introduction
Setting things up
S1. Setting up your Git identity
S2. Setting up your private repo
S3. Backuping your private repo (only developers at CERN)
S4. Setting up your public repo
S5. Pushing to your public repo from outside CERN
S6. Making your public repo visible on the Web
S7. Using remote repository locally
Understanding official repo branches
maint
master
next
Working on new features - overview
Working on new features - details
W1. Cloning the repo
W2. Working with local topic branches
W3. Working on new-feature-b
W4. Using temporary stash
W5. Testing on DEV servers
W6. Rebasing against latest git/master
W7. Publishing your work
W8. Review process
Remarks often made during code review
R1. Remarks on commit history
R2. Remarks on commit log messages
R3. Remarks on the coding
R4. Notes on the review process timeline
Commit quality check
Patterns
Docker
Setup
Interactive sessions
Debugging
Code changes and live reloading
Building documentation
Running tests
Overlays
Admin’s Guide
BibAuthority Admin Guide
Introduction
Enforcing types of authority records
BibEdit
BibIndex
Configuration File Overview
BibClassify Admin Guide
1. Overview
1.1 Thesaurus
1.2 Keyword extraction
2. Running BibClassify
BibConvert Admin Guide
A. Overview
B. XML-Oriented Mode
1. Configuration File Examples
2. Running BibConvert
C. Plain Text-Oriented Mode
1. Configuration File Examples
2. Running BibConvert
3. BibConvert Configuration Guide
BibEdit Admin Guide
1. Overview
2. Edit records via Web interface
2.1 Keyboard shortcuts on BibEdit
3. Edit multiple records via web interface
3.1 Multi-Record Editor user guide
4. Edit records via command line
5. Delete records via command line
6. Delete all records
7. Access record history
BibKnowledge Admin Guide
Contents
1. Overview
2. Configure Knowledge Bases
2.1 Add a Knowledge Base
2.2 Remove a Knowledge Base
2.3 Add a Mapping
2.4 Remove a Mapping
2.5 Edit a Mapping
2.6 Edit the Attributes of a Knowledge Base
BibMatch Admin Guide
1. Overview
1.1 What is BibMatch
1.2 Features
2. Usage
2.1 Basic usage
2.2 Advanced usage
3. More examples
3.1 More examples
Appendix
A. Querystrings
B. BibConvert formats
C. Predefined fields
D. BibMatch commmand-line tool
BibSched Admin Guide
Overview
Bibsched graphical interface
Manual mode
Automatic mode
Bibsched maintenance
Priorities
Task logging
Task concurrency
Configuration
Bibsched command line interface
Bibtasks command line interface
BibSched Tasklets
BibUpload Admin Guide
1. Overview
2. Configuring BibUpload
3. Running BibUpload
3.1 Inserting new records
3.2 Inserting records into the Holding Pen
3.3 Updating existing records
3.4 Inserting and updating at the same time
3.7 Obtaining feedbacks
3.8 Assigning additional information to documents and other entities
4. Batch Uploader
4.1 Web interface - Cataloguers
4.2 Web interface - Robots
4.2 Daemon mode
DocExtract Admin Guide
OAIHarvest Admin Guide
1. Overview
2. OAI Data Harvesting
2.1 OAI Harvest Admin Interface
2.2 oaiharvest commmand-line tool
OAIRepository Admin Guide
1. Overview
2. OAI Repository (
Exporting
)
2.1. Definition of OAI sets
2.2. Exposing metadata via OAI Repository Gateway
Publiline Admin Guide
Introduction
Configure Publiline
Step 1 : Define a Publication Committee Chair
Step 2 : Create a Group
Step 3 : Define Project Leader(s)
Overview and usage
WebMessage Admin Guide
WebSession Admin Guide
Guest User Sessions
WebStyle Admin Guide
Contents
1. Overview
1.1 CSS Style Sheet and Images
1.2 HTML Page Layout
1.3 Look of Bibliographic References
1.4 Specific Configurations
2. Detailed Record Pages
2.1 Available tabs
2.2 Showing/Hiding tabs
2.3 Customizing content of tabs
2.4 Customizing look of tabs
Custom Redirections
Command Line Interface
API
Base
invenio.base
Wrappers
Factory
Bundles
Extensions
Assets
Flask-Script commands
Jinja2 extensions
Registry
Wrappers
ArXiv
Configuration Settings
CrossRef
Configuration Settings
Elasticsearch
Cloud Filesystems
Dropbox
Google Drive
Jasmine
Missing features
FlightJS tests
Fixtures
HOWTO
Logging
Logging errors
Log handlers
Legacy handling of errors
Error handling do’s and don’ts
Backends
Login
invenio.ext.login package
invenio.ext.login.legacy_user module
Passlib
Configuration Settings
Script
Configuration
Session
Backends
Wrappers
SQLAlchemy
Templates
Jinja2 extensions
Config
Loader
BCCache
Context Processor
Modules
Annotations
invenio.modules.annotations
Models
Noteutils
Views
API Keys
Documentation
Configuration
Views
Documents
invenio.modules.documents.api
invenio.modules.documents.errors
Formatter
JSONAlchemy
Module Structure
Configuration
How it Works
How to Extend JSONAlchemy Behaviour
Invenio Use Cases
API Documentation
Knowledge
Model
API
OAuthClient
Authorization Flow Overview
Usage
Configuration
Contrib
API
Redirector
Model
API
Manage
Upgrader
Recommendations for writing upgrades
Upgrade modules
Upgrade dependency graph
Models
Uploader
Tasks
Workflows
Workflows
Create a workflow
Create a task
Run a workflow
Holding Pen
API
Models
Engine
Workers
Views
Utilities
Datastructures
Washers
Forms
Legacy
BibRecord
Community
Code of Conduct
Deprecation policy
Fast track deprecation
How to deprecate a feature
Upgrading
Recommendations for writing upgrades
Upgrade modules
Upgrade dependency graph
License
Authors
Invenio License
Invenio
Docs
»
Developer’s Guide
»
How to develop a module: Part 3
How to develop a module: Part 3
¶
Tests
¶
TODO
Documentation
¶
TODO