References Application

Last modified by Thomas Mortagne on 2024/07/15 00:10

cogAllows you to enter project names, information and images
TypeXAR
CategoryApplication
Developed by

Vincent Massol

Active Installs7
Rating
1 Votes
LicenseGNU Lesser General Public License 3

Installable with the Extension Manager

Description

Once the Application is installed, use the References page to enter a new ref. Individual reference pages display the first image you attach to the page. The References application also allows you to display a list of projects & images on a page displaying a quick view of all References.

The best way to grasp the concept is to see how it works on the References Page (Code View available here).

How to use

All you have to do is to download the XAR and import it in your XWiki. Then you will be able to add new references on the http:///xwiki/bin/view/References/ page.

The Template and Sheet are available on http:///xwiki/bin/view/XWiki/ReferenceClass.

You can change the default image to another one. To do so, you need to change 2 things.

  • On the http:///xwiki/bin/view/References/ page, you need to replace the image URL with the one you want to use (this is the thumbnail):
79:       #else
80:          <img style="width: 100px; height: 87px; border: 1px; border-color: #000000; border-style: solid;"
src="http://www.xwiki.org/xwiki/bin/download/References/WebHome/XWikiReferenceThumbnail.png"/>
81:       #end
  • On the http:///xwiki/bin/view/XWiki/ReferenceClassSheet page, you need to replace the image URL with the one you want to use (this is the large one):
57:  #else
58:   <img style="width: 400px; border: 1px solid #000000; margin-top: 14px;"
src="/xwiki/bin/download/XWiki/ReferenceClassSheet/XWikiOrgReference.png"/>
59: #end

The References Application can be seen in action on the References Page.

Screenshots

Main References Page

IndexReferencePage.png

Individual Reference Page

ReferencePage.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Get Connected