GUIDELINES for Editors

Introduction to bmesource Hierarchy, Structure and Links Editing Instructions Editorial Responsibility

Contact

    |    
Audience
Specification
Page Edit
Details
Reference Page
Specifics
Adding Product
Sites
Other Special
Links

 * 

Editing Instructions

General Page Editing Instructions
If your task is to modify the site, you change existing pages by clicking the "Edit this page" link on that page. Changes can then be made on the editing form. If desired, you can preview changes on the edit page before saving. Once you click “Save” on that page, your contents will replace the previous version. It is preferred that only Senior Editors or Central Staff use this feature.

While editing, you can link to another page on the bmesource.org site by putting the page name between asterisks (eg. *Start*). If the page exists, it will be linked to. If the page does not exist, it will be created and linked to. Page links can only contain letters, numbers and underscores (_). NO spaces are allowed. To link to an external site, you must enter the complete HTML including the fully-qualified link reference (URL): e.g. <a href=”http://www.site.com/”>Your Link Name</a>.

Page Titles
The Wiki page structure is flat. That is, all pages are equivalent in the database. As such, each page must have a unique name. To ensure uniqueness, start with the subject you are covering. Next, consider if this subject may appear in another area of the site. If you think it might, append a specialty to your subject. Thus potentially ambiguous names will be of the format “Specialty_Subject” e.g. surgery, if in the cardiovascular (cv) area, would be titled CV_Surgery. Note: mix cased is use for whole words.

*

 Page Summary

General:

Page titles - contain letters, numbers and underscores (_). NO spaces

Add custom nav to every page: start > first_page > next_page > Here

Specific:

Do not change domains

Section ontologies are the responsibility of the Senior editor

Topics include link groups, decided by Senior Editors

Custom Navigation
Wiki provides a top level navigation but little else. On bmesource.org we are supplementing that with a “bread-crumb” navigation to each page for two reasons: 1) It allows the user a simple navigation method; and 2) it also provides some level of instruction – that is, if the user has reached a page via search or other direct means, he/she can see immediately where the particular concept fits in the hierarchy of the site. In order to provide this feature, we ask that section editors add navigation to the top of each page of content. Please use the following format, where each page named (including start) is a link to that page. The word “Here” is not a link.

Start > first_page > next_page > Here

(within the edit frame it would read *Start* > *first_page* > *next_page* > Here)

Specific Editing Information
Domains
Domains are fixed. Only the managing editorial team should be altering the Start page for bmesource.org. This page defines domains and sections for those domains.

Sections
Each Senior Editor is responsible for the topics, columns, link groups and links found in the assigned section. Most sections have an existing structure, which may be used as a starting point or re-designed. However, once the topics are determined and population of links begins, the topic categories should remain relatively static. The stability of these elements will help ensure that users of the site will be able to use the site over time without confusion.

Determining the topic structure is the responsibility of the Managing Editor in collaboration with the Senior Editor. Please note that a general section is often used to start a section’s page. This general Section contains link groups and links that encompass the entire area of the Section or are not clearly identifiable with one of the topics. For instance, in Medicine, the General Section includes anatomy, physiology and pharmacology. This first Topic is left-justified in line with the custom navigation (Start > page > page). The remaining topics are indented with the use of a <blockquote> HTML element. Topics are in alphabetical order following the indent. Each topic should have listed the link groups (also in alphabetical order) that are included within that topic, like this:

Topic Name
Includes: Link group 1, Link group 2, Link group 3, Link group 4, Link group 5, Link group 6, Link group 7

Link groups should be in alphabetic order and should include all link groups of the topic page, regardless of distribution between the three columns.

Topics
Topic pages are organized in columns according to their domain. For Engineering the columns are labeled OVERVIEW, TECHNOLOGY, and APPLICATION. Each column label is designated as a H4 (heading level in HTML). Each column label is uppercase. Link Group Names are designated by <b>(bold). Note that in each column there may be sets of links that do not fit under a particular link group. These links should be directly below the column label. This may be particularly prevalent in the Overview column.

Figure 1: Sample Topic Page (Valvular):
Sample Page from bmesource

HTML formatting for the Engineering Topics layout is as follows:
< table width="100%"><tr valign="top"><td><h4>OVERVIEW</h4>
link 1 (general overview link – does not fit in link group)
link 2
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td><td><h4>TECHNOLOGY</h4>
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td><td><h4>APPLICATION</h4>
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td>< /tr></table>

HTML formatting for Medicine Topics:
< table width="100%"><tr valign="top"><td><h4>OVERVIEW</h4>
link 1 (general overview link – does not fit in link group)
link 2
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td><td><h4>DIAGNOSIS</h4>
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td><td><h4>TREATMENT</h4>
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td>

HTML formatting for the Business/Law Topics layout is as follows:
< table width="100%"><tr valign="top"><td><h4>OVERVIEW</h4>
link 1 (general overview link – does not fit in link group)
link 2
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td><td><h4>METHODS</h4>
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td><td><h4>APPLICATION</h4>
< b>Link Group Name</b>
link 1
link 2
< b>Link Group Name</b>
link 1
link 2
< /td>< /tr></table>

Link Groups
Link group names should be selected to describe the groups you have created. See Figure 1 for a sample page showing how link groups look on the site. Names should be bold using the <b> format. There should be a space above but no space below e.g.

link 2

< b>Link Group Name</b>
link 1
link 2


©2005 bmesource.org