Extension:OfflineImportLexicon

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
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 License
Download
Added rights
offlineimportlexicon
Hooks used
BeforePageDisplay
SkinAfterContent
ArticleSaveComplete
Translate the OfflineImportLexicon extension if it is available at translatewiki.net
Check usage and version matrix.

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]

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/OfflineImportLexicon/ directory of your MediaWiki installation.

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

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

Installation[edit]

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

  • Download and place the file(s) in a directory called OfflineImportLexicon in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/OfflineImportLexicon/OfflineImportLexicon.php";
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Setup[edit]

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]

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]

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]

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