Style Guide

From Faith Futures
Revision as of 22:51, 12 March 2011 by Admin (Talk | contribs) (moved Template:Style Guide to Style Guide: better idea!)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This page has information members of the project team about the conventions for coding the pages.

Wiki protocols

By default the site will adhere to the current wiki protocols as they are developed and published within the wiki community.

Key information resources for these protocols, as well as comprehensive documentation on technical points, is available at:

You can play around in the sandbox [1] to get a feel for how the editing buttons and related functions actually work. For example typing * at the start of a new line generates a neat little blue bullet point, as follows:

  • Bullet point text

Jesus Database items

Naming conventions

The naming conventions for JDb wiki pages are:

  • three digit Crossan number (001, 069, 520, etc)
  • then a space
  • then the name of the item from Crossan (case sensitive), but with apostrophe s becoming just "s"

The published list of all 522 items in the Crossan Inventory provides the reference point for capitalisation, punctuation, etc.

Use of headings and sub-headings

Use H2 headings for major sections (Data, Text, Parallels, etc).

Use H3 headings for sub-sections, such as major text groups, different categories of parallels, etc.

New Jesus database item page

When starting a new Jesus database page, simply click on the red link to create a blank new page with the correct number and title in its name. From that point follow the standard template, etc.

Additional pages for the same Jesus Database item

When an additional page is needed to handle the gathered information relevant to one of the 522 items, the three digit standrad reference number miust occur at the beginning of the new page name to assist in locating all relate pages, eg:

Creating wiki pages from old html JDB pages

Sometimes the material for a new wiki page can be retrieved from one of these locations:

  • the source code of a wiki page lost in the 2008 hardware failure, but preserved online at the Internet Archive
  • the html code from the pre-wiki version of the site (these files are in the DropBox site)

When doing this considerable editing of the older code will be needed.

One process is to prepare a simple text file with all the content, anf then paste it into the new wiki page.

Another option is to copy/paste portions of the older code directly into the relevant sections of the new wiki page. This works best when just a small amount of content is available for transfer: eg, just the Crossan data and the actual text of the item. It can be very time consuming, and especially if the old html code included a multi cell table with voting data. In such cases, it may be best to omit the table and look for another way to describe the JS voting results. Some old hyperlink codes also need to be removed at this stage, and final check for blank spaces that can make a wiki page render badly.

Site specific information

Protocols for starting new pages

As a general note, it is helpful to put a short line at the start of each page that identifies the project or discussion area with which it most directly relates. Therefore, we ask all contributors to include a line such as the following for each new page they create, for example:

"This page is part of the Jesus Database project."

Such a practice has three immediate benefits:

  • the SEARCH function will more easily find all pages connected with a particular project
  • readers can quickly go to the main page for the project within which the page sits
  • editors creating a new page would be invited to locate their page explicitly in the project where they see it most properly belonging

When starting a new Jesus database page, simply click on the red link to create a blank new page with the correct number and title in its name. From that point follow the standard template, etc.