Template:Annotated-lv-card/Help

From WikiEducator
Jump to: navigation, search

The {{annotated-lv-card}} template may be used on a page representing a Liberating Voices pattern card.

It should only be used in this way.

This Help page outlines how to "populate" a card once this template has been saved on its page.

See the Usage section of {{annotated-lv-card}} for technical details.

Use Wikitext

Be sure to use Wikitext[1] for the steps below. Either Disable the Rich editor or switch to wikitext by clicking on 'Wikitext' when editing a page:

Creating a card page

The title of the page is the name of the card/pattern prefixed with 'LV:'. One way of creating a card page is to edit a page from which you will link to that card page and create the link with something like the following Wikitext:

[[LV:<name of pattern>]]

(replacing <name of pattern> with the name of the pattern the card represents)

Save the page and click on the link you have created to open the new card page[2] for editing and paste the following into it[3]:

{{annotated-lv-card}}

Save the page and you should see something like[4] the following:

Newly created card page

Edit properties of the card

Some of the properties appear on the card itself (such as 'card-text', 'image', 'text-by' and image-by').

Others are describing the card and only appear on the annotated version you see on the card's page.

To edit a property, click on the relevant property link and edit the sub-page which opens. The content you enter into the sub-page will be drawn into the card or the annotated version you are currently working on.

In general, just one precise line of text is required. Remember to save the page you edited.

If you edit anything and have an interest in the card, 'watch' the page[5] you edited and any of its other sub-pages of interest.

In your 'preferences' you can arrange to be e-mailed if pages on your watch list are changed.

To see your changes it is often necessary to reload the card page. Sometimes you may need to 'edit' the page and [Show preview] and/or [Save] the card again (buttons under the edit box) - without actually changing it to see your changes[6].

List of properties

To fully "populate" the card, save the page and edit the Properties[7] of the card by clicking on the links to the properties (each represented in a sub-page) which include:

No. (stored in sub-page /no) - the number of the card (an integer from the book patterns)

Suit (stored in sub-page /suit) - currently just the categories of the book patterns.

Text (stored in sub-page /card-text) - the text of the card (usually one short paragraph)

Text by (stored in sub-page /text-by) - name of author(s) - best on one line

Image (stored in sub-page /image) - name of the image on Wikimedia Commons
See the Resources page for hints on sourcing and uploading images.

Image by (stored in sub-page /image-by) - name of the artist(s) or photographer - best on one line

Images (stored in sub-page /images) - a page for listing alternative images for the pattern card

Related cards (stored in sub-page /linked-cards) - add links to related card categories (e.g. [[:Category:LV:Theory]]) - see Category:Liberating Voices and use its sub-categories).

PSP page (stored in sub-page /psp-page) - URL of the corresponding book pattern on the Public Sphere Project's web site.

Status (stored in sub-page /status) - status of the card[8] as a whole (percent complete: accepts one number - one of 0, 10, 20, ..., 100).

Status of text (stored in sub-page /text-status) - use one of the keywords as per progress key (right)
Status of image (stored in sub-page /image-status) - use one of the keywords as per progress key (right)
Status comment (stored in sub-page /status-comment) - describe the status.

Etc (stored in sub-page /etc) links to anything related to the card such as related learning resources, projects using it, variations, etc.

To Do

  • Update the image of an annotated card page - there are more status fields.
  • Consider including a category link in the template instead of having [[Category:LV:{{:{{PAGENAME}}/suit}}]] in each page.

Notes

  1. For an introduction see Basic Editing.
  2. If the page exists already it is already linked so no problem.
  3. This is a pre-prepared template which generates the content for a Liberating Voices card page.
  4. The appearance may change but the essential content is not expected to change much over time.
  5. See Useful features of WikiEducator for an explanation of how to do this.
  6. The reason for this is technical, related to caching mechanisms used by the software which helps reduce the load on the server.
  7. The properties are also described in the Usage section of {{annotated-lv-card}}.
  8. If you use one of the specific keywords or numbers for the status, the background colour of the status cell will change. Expand keys on the right to see colours for status cell.