Extension:RefHelper

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

Release status: experimental

Refhelper.png
Implementation Special page
Description Helps manage references. Adds a special page for adding references to the wiki in a predefined format.
Author(s) JonathanWillifordTalk
Last version 0.0.2 (2010-02-11)
License GNU General Public License v2
Download Download snapshot
Subversion [Help]

Browse source code
View code changes

Example http://neurov.is/on/
Hooks used
SkinTemplateToolboxEnd

BeforePageDisplay

Check usage (experimental)

Contents

[edit] About

While I have much bigger plans for this extension than what is currently implemented, I currently use it on my website http://neurov.is/on and find it quite helpful. I would be interested in other people's ideas on what features would be nice for this extension. If you are interested in this extension, please contact me via Special:EmailUser/JonathanWilliford so that I can help.

Currently this extension:

  • Creates a new SpecialPage that allows you to add reference information. You give the reference a unique name such as "Hubel 1968".
  • Creates a new SpecialPage that allows you to search for references from PubMed and then directly import the references from PubMed.
  • It then allows you to link to it with:
    • {{ref|Hubel 1968}} or
    • {{:Cite:Hubel 1968}}
  • The title of the page will be a link to a wiki page where you can add more information, such as notes and links to download.

[edit] Installation

  1. Download the files from SVN and place them in $IP/extensions/RefHelper/
  2. Add the following to LocalSettings.php:
    require_once("$IP/extensions/RefHelper/RefHelper.php");
    define("NS_CITE", 120);
    define("NS_CITE_TALK", 121);
    $wgExtraNamespaces =
       array(NS_CITE=>"Cite",
             NS_CITE_TALK=>"Cite_talk",
            );
    
  3. Download or create the required templates. See below.

The extension namespaces have been registered in order to avoid conflict with other extensions.

[edit] Configuration parameters

  • $wgRefHelperCiteNS
    
    - name of the namespace used for the citations.
  • $wgRefHelperCiteTemplate
    
    - specifies the template that is used to create the citation page (the page in the $wgRefHelperCiteNS namespace). Prefix with "subst:" if you want a substitution performed.
  • $wfRefHelperPageTemplate
    
    - specifies the template that is used to create the normal page (the page in MAIN_NS). Prefix with "subst:" if you want a substitution performed.
  • $wgRefHelperExtensionPath
    
    - the http path to the extension, used to find the javascript file.

[edit] Templates

You need to install Extension:ParserFunctions in order for these templates to work. The recommended templates are at Extension:RefHelper/templates. You will need to add some templates in order to get the extension to work.

[edit] Using with DynamicPageList (third-party)

If you install the DynamicPageList (third-party) extension, you can list all of the references that belong to a set of categories. For example:

<DPL>
category = Visual system
category = References
format   = ,\n* {{cite:%PAGE%}},,
ordermethod = title
</DPL>

Will list all of the citations that belong to both the Visual system and References category (the References category is automatically added to all of the citations by RefHelper).

[edit] Who uses this extension?

Please add your site if you use this extension.

[edit] Desired features

Please put any features you would like to have added here.

  • Add a tag that displays the references from an article. Ex. <ArticleRefs name="Hubel 1962">format=...</ArticleRefs>.
    • This will require doing something like this:
http://eutils.ncbi.nlm.nih.gov/entrez/eutils/elink.fcgi?dbfrom=pubmed&id=19372142&LinkName=pubmed_pubmed_refs&cmd=neighbor
  • Allow the auto-creation of new categories (if a user types in a new category when creating a new reference, that category will be created using user configurable template).
  • Auto-suggestion when typing in categories, using categories previously used in references.
    • As an intermediate goal, the creation page could indicate whether a typed category exists yet or not.
  • Import from EndNote and RefMan.

[edit] See also

Personal tools
Namespaces
Variants
Actions
Site
Support
Download
Development
Communication
Print/export
Toolbox