Documentation:Open Case Studies/Wiki Set Up

From UBC Wiki
Jump to: navigation, search

This page is for the hour long working session to set up the wiki architecture for Open Case Studies.

Session Outline

This working session is for the planning group associated with the Open Case Studies project in Environmental Ethics. The goal of the session is to:

  • Create the infobox template as a navigation aid for project participants/creators of case studies using the UBCWiki.
  • Identify any further architecture/ template strategies or approaches to support the work of the participants in the upcoming preparatory workshop and 2 day sprint.
  • Build capacity on the team for supporting the development of case study content in the wiki.

Basic Architecture

Basic principles to apply when setting up a multi-page architecture for a wiki project:

  • general to specific - landing pages/general - subpages/specific
  • keep page titles short - sub-pages may go 3-4 levels deep. A suggested architecture for this project may look something like:
  • Documentation: Open Case Studies
  • Documentation: Open Case Studies/Environmental Ethics
  • Documentation: Open Case Studies/Environmental Ethics/Case Study Title
  • Documentation: Open Case Studies/Environmental Ethics/Case Study Title/ Geographer's Perspective
  • set up the structure of the project first so that people adding content do not have to guess where that content goes.

Index Landing Page

The purpose of an index landing page is to give context to your project and act as a navigation aid for collaborators. The index landing page should always be accessible via the "breadcrumb" links at the top of a page. It is the "root" where all other subpages will spring from.

Subpages

These pages are generally for the more specific content related to the broad theme (see basic principles above). They may go 3-4 levels deep.

Questions:

  • Are we using Environmental Ethics and the "subgroup" of Open Case Studies? Or?
  • Would you expect that (during the sprint), people will be creating their own pages for case study and perspectives? We may want to consider a template for page creation. UBC Mix is an example.

Infobox Templates

Why create an infobox template?

  • acts as an index for categorized pages - so makes it easier to keep track of content
  • provides a visual "organizer" on the wiki for related content pages (for example - sections of a course, project space, etc.)

How to create an infobox for your project

Part 1: Create the Infobox Template

  • Create a page called Template: Infobox Your Project Name
  • Open another tab on your browser and navigate to an existing template (Example: Infobox Open UBC)
  • Navigate to the edit screen on the example template, and copy the code to your newly created template page.
  • Change the parameters in the code:
  • replace the project title and description as indicated in the example code.
  • change the category to the one used for your project: example Open Case Studies
  • upload and add your image. I've found it helpful to encourage groups to choose an image they can use as a visual connector with a website or other project components - it gives the project a sense of cohesion.
  • leave or change the CC Licence code at the end of the sample page - according to your preference.
  • background color of template by replacing the color hex on the template (for example: background:#2f5d7c) . You can find the color hex using the Color Picker tool

Part 2: Create the Infobox Documentation

  • After you save your template, a box that says "[create ]Template documentation" will appear. Click on the create button.
  • Open another tab on your browser and navigate to an existing template documentation (Example: http://wiki.ubc.ca/Template:Infobox_OpenUBC/doc)
  • Navigate to the edit screen on the example template documentation and copy the code to your newly created template documentation page.
  • Change the parameters in the code:
  • replace the text on Usage and How to use.
  • replace the 2 infobox to Template:Infobox Name of the Project. (For example, if the project name is called Open Case Studies, it will be
    {{Infobox Open Case Studies}} 

Creative Commons license templates