Extension:OfflineImportLexicon

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
OfflineImportLexicon

Release status: beta

Implementation User interface, Special page
Description Provides a user interface that allows to create wiki pages following hierarchical book's structure: book, volume, article, physical representation of book page as image.
Author(s) Lia Veja (LiaVejatalk)
Latest version 2.0.0 (2012-12-29)
MediaWiki 1.17+
Database changes No
License MIT
Download
Added rights

offlineimportlexicon

Hooks used
BeforePageDisplay

SkinAfterContent
ArticleSaveComplete

Translate the OfflineImportLexicon extension if possible

Check usage and version matrix; code metrics

The OfflineImportLexicon extension is an extension for Semantic MediaWiki that provides a user interface that allows to create wiki pages following hierarchical book's structure: book, volume, article, physical representation of book page as image. Entities are:

  • Book (Lexicon)
  • Volume
  • Article (Lemma)
  • Page as images.

It was developed within the research project SMW-CorA and funded by the DFG.

Download[edit | edit source]

You can download the extension directly from the MediaWiki source code repository (browse code). You can get:

One of the extensions tags

Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag

  • Go to the tags list
  • Click the name of the tag you want to download
  • Click "snapshot"
The latest version of one of the extensions branches

Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.

  • Go to the branches list
  • Click the branch name
  • Click "snapshot"
A snapshot made during the release of a MediaWiki version.

This might be unstable and is not guaranteed to work with the associated MediaWiki version.

After you've got the code, save it into the extensions/OfflineImportLexicon directory of your wiki.

If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:

cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/OfflineImportLexicon.git

Installation[edit | edit source]

Note Note: This extension requires Semantic MediaWiki to be installed first.

  • Download and extract the files in a directory called OfflineImportLexicon in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
  • Add the following code at the bottom of your LocalSettings.php:
require_once( "$IP/extensions/OfflineImportLexicon/OfflineImportLexicon.php" );
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Setup[edit | edit source]

After the installation, you have to create Templates as follows:

For books (lexicon)
{{Cora Lexicon Data
| Title =
| Subtitle = 
| Place of Publication  =
| Editor = 
| Coordinator =
| Author = 
| Publisher = 
| Language = 
| Edition =
| URN =  
| Year of Publication =  
| IDBBF =  
| Has Volume = 
}}
For volumes
{{Cora Volume Data
| Title =
| Subtitle = 
| Volume Number =
| Place of Publication  = 
| Publisher = 
| Editor =
| Language = 
| URN =  
| Year of Publication =  
| IDBBF =  
| Physical Description =  
| Part of Lexicon = 
}}
For articles, tables of contents (TOC), prefaces, lemmas
{{Cora Lemmata Data
| Title =
| Subtitle = 
| Part of Lexicon = 
| Part of Volume = 
| Language = 
| URN =  
| IDBBF = 
| Original Person =
| First Page =  
| Last Page =  
| Has Digitized =
| Category = 
}}
For authors
{{Authors Data
|Author =
}}
For physical pages
{{Cora Image Data
| Original URI =  
| Rights Holder =  
| URN = 
| Page Number = 
| Page Numbering = 
| Part of Article =  
| Part of TitlePage =
| Part of TOC = 
| Part of Preface =
}}

Usage[edit | edit source]

This is a brief introduction on how to use the OfflineImportlexicon. A more detailed guide will appear on this page in the near future.

Creating book structure[edit | edit source]

After successful installation, the special page OfflineImportLexicon will be created in your wiki under Semantic MediaWiki Group. Clicking this link, the special page launches and an initial form allows user to enter new books (lexicons). Clicking the Add New lexicon button starts the "New Lexicon Form". This offers to insert bibliographic information about a book. For each book, you can add volumes, and, for a collected edition, articles related to the book (lexicon). In these forms, you can specify the details of your currently created entity. After finishing the description process a wiki page will be created using corresponding template mentioned above. In addition, for articles, you can choose to generate also media file. In a subsequent session, you can add a scanned image of the physical book page.

Known issues[edit | edit source]

If you find a bug, please report it on the discussion page.