Help:Contents
From HPSIGWiki
To report technical problems email hpsigadmin@evanspeck.com
Contents |
For content issues edit the project page or discussion page associated with each project page
Getting Started
Using Categories
Please see documentation on customizing the interface and the User's Guide for usage and configuration help.
HPSIG Style Manual
Page Design
Every page will have an uneditable header that is equal to the name of the link that created the page in the first place. See "Creating Hyperlinks" below.
Thereafter, all formatting on a page is under the control of the person who created the page and all people who contribute to the page.
The general hierarchy of page style is as follows:
Page Title (In addition to the uneditable page name)
- Required: No
- Recommended: Yes
- Font Size: +2
- Markup Code:
- <font size="+2">'''Page Title'''</font>, or
- <font size="+2"><b>Page Title</b></font>
- Other Formatting: None
- Comments: None
Major Section Header
- Required: No
- Recpommended: Yes
- Font Size: Determined by markup code
- Markup Code:
- ----
- =='''Section Title'''===, or
- ==<b>Section Title</b>===
- Other Formatting: Use two carriage returns to separate the beginning of a major section from the content that appears above a major section header.
- Comments:
- The use of major section headers is realtive to the purpose and length of the page. A very brief page does not benefit from section headers, while longer pages do. Long pages that are not broken into sections are daunting and difficult to read. Sections help the reader understand the overarching ocontent of the page, and gives her/him a degree of orientation while reading the content.
- Section headers make pages easier to understand and read. Section headers also appear in the automatically generated Table of Contents (unless the TOC is suppressed, see Table of Contents below).
- The use of the double equal size before and after the major section header text will automatically add a line underneath the text. The placement of "---" (without the quote marks) adds a line above the text.
Secondary Section Header
- Required: No
- Recpommended: Yes
- Font Size: Determined by markup code
- Markup Code:
- ===Section Title====
- Other Formatting: Use two carriage returns to separate the beginning of a secondary section from the content that appears above a secondary section header.
- Comments:
- The use of secondary section headers is realtive to the purpose and length of the page. A page with relatively brief major section headers does not benefit from secondary section headers, while longer major sections do. Long major sections that are not broken into sections are daunting and difficult to read. Secondary sections help the reader understand the overarching content of the major section, and gives her/him a degree of orientation while reading the content.
- Secondary section headers appear in the automatically generated Table of Contents (unless the TOC is suppressed, see Table of Contents below).
Tertiary Section Header
- Required: No
- Recpommended: Yes
- Font Size: Determined by markup code
- Markup Code:
- ====Section Title=====
- Other Formatting: None.
- Comments:
- The use of tertiary section headers is realtive to the purpose and length of the secondary section. Tertiary sections help the reader understand the overarching ocontent of the secondary header content, and gives her/him a degree of orientation while reading.
- Tertiary section headers appear in the automatically generated Table of Contents (unless the TOC is suppressed, see Table of Contents below).
Quaternary Section Header
- Required: No
- Recpommended: Yes
- Font Size: Determined by markup code
- Markup Code:
- =====Section Title======
- Other Formatting: None.
- Comments:
- The use of quaternary section headers is realtive to the purpose and length of the tertiery section. Quaternary sections help the reader understand the overarching content of the tertiery header content, and gives her/him a degree of orientation while reading.
- Quaternary section headers appear in the automatically generated Table of Contents (unless the TOC is suppressed, see Table of Contents below).
Citation for a paper
Under construction...
Listing a simulation or qualitative model
Under construction...link to instructions for uploading amodel what the model page is implemented
Hyperlinks
Under construction...
General Formatting
All of these notes relate to working in a page's edit mode (click the edit tab at the top of the page).
Headers
Use consecutive equal signs to have text appear in different sized fonts.
A single = sign is the highest level and the largest font. It is the same as <h1>text</h1> in HTML markup code.
A double == sign is the next level, equal to <h2>text</h2> in HTML markup code.
A triple === sign is the next level, equal to <h3>text</h3> in HTML markup code.
A quadruple ==== sign is the next level, equal to <h4>text</h4> in HTML markup code.
A quintuple ===== sign is the next level, equal to <h5>text</h5> in HTML markup code.
For all of these, you may also use the HTML markup code itself.
Table of Contents
Standard TOC
For each page with more than three headings, a table of contents (TOC) is automatically generated from the section headings, unless:
- (for a user) preferences are set to turn it off
- (for an article) in the edit box __NOTOC__ is added
With __FORCETOC__ or __TOC__ in the wikitext a TOC is added even if the page has fewer than four headings. With __FORCETOC__ the TOC is put before the first section header. With __TOC__, it is put at the position of this code. This allows any positioning, also e.g. on the right, and in a table cell, and it also allows multiple occurrence, e.g. in every section; however, this seems only useful if the sections are long, so that the TOCs take up only a small part of the total space. Thus there may be some introductory text before the TOC, known as the "lead". Although usually a header after the TOC is preferable, __TOC__ can be used to avoid being forced to insert a meaningless header just to position the TOC correctly, i.e., not too low.
Compact TOC
Where you have a large number of very short headings (such as letters of the alphabet) you can get a very long table of contents. An alternative is a compact TOC. You can insert the following text:
{{compactTOC}}
which looks like this:
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
You can do similar things with years or decades e.g.
1900s - 1910s - 1920s - 1930s - 1940s - 1950s - 1960s - 1970s - 1980s - 1990s - 2000s
Bullets
The fast and easy way to add bullets is to place a single asterisk before the item you want to appear with a bullet.
While it edit mode, typing:
*Item 1
*Item 2
will render:
- Item 1
- Item 2
You may nest bullets by using additional asterics.
Typing:
*Item 1
**Item 1.1
**Item 1.2
*Item 2
**Item 2.1
**Item 2.2
***Item 2.2.1
***Item 2.2.2
*Item 3
will render:
- Item 1
- Item 1.1
- Item 1.2
- Item 2
- Item 2.1
- Item 2.2
- Item 2.2.1
- Item 2.2.2
- Item 3
You may also use the <ul><li>text</li></ul> HTML markup code for a more complex or controlled list of bullets.
Numbered list
You can create a numbered list by using the pound sign (#) infront of an entry. While it edit mode, if you type:
#Item 1
#Item 2
#Item 3
it will render (note that numbering is always indented):
- Item 1
- Item 2
- Item 3
You can create nested numbered outlines but they are not particularly clear. For example, typing:
#Item 4
##Item 4.1
##Item 4.2
will render:
- Item 4
- Item 4.1
- Item 4.2
Definition list
You can create a definition list by placing a colon (:) in front of an entry. While in edit mode, if you type:
:Item 1
:Item 2
it will render (the content is indented from the left margin):
- Item 1
- Item 2
You can create nested definition lists. For example, typing:
:Item 4
::Item 4.1
::Item 4.2
will render:
- Item 4
- Item 4.1
- Item 4.2
Adding a Comment to the HTML Markup Code
While the page is in edit mode, you may add comments that will not render when the page is viewed by people visiting the page. A comment must begin with "<!--" and end with "-->". In practice, do not type the quote marks. To see an example of a comment, put this page into edit mode and scroll down to this section. A comment, while not visible, does take up real estate and will add white space to the rendered page.
Line Spacing
When the page is in edit mode, the following conventions govern line spacing.
A single hard return at the end of a line has no effect. Even though the text is on a different line in edit mode, it will render the text as though it was on the same line. For example:
This is the first sentence.<hardreturn> This is the second sentence.
renders:
This is the first sentence. This is the second sentence.
A double hard return at the end of a line ends the text where the hard returns occur and starts a new line. There is no white space between the lines (other than that which naturally occurs between the lines, such as what you see right now). For example:
This is the first sentence.<hardreturn> <hardreturn> This is the second sentence.
renders:
This is the first sentence.
This is the second sentence.
A triple hard return at the end of a line ends the text where the hard returns occur and starts a new paragraph. For example:
This is the last sentence of one paragraph.<hardreturn> <hardreturn> <hardreturn> This is the first sentence in the next paragraph.
renders:
This is the last sentence of one paragraph.
This is the first sentence in the next paragraph.
Enclosing Text in a Box
Any line that begins with a space will produce text with a dotted box around it. Blank lines also have to have a space. If you use a real hard return between lines that begin with spaces, a separate box will appear for each line.
<space>This is line one.
<space, hardreturn>
<space>This is line two.
renders:
This is line one. This is line two.
<space>This is line one.
<no space, hardreturn>
<space>This is line two.
renders:
This is line one.
This is line two.
Using HTML markup code
See Wiki Help for HTML tags for additional information on using HTML tags while in edit mode. See HTML Elements for an extended discussion of HTML tags.
Uploading and Linking to Files
Uploading
To upload a file you need to login under a user name. Go to the Toolbox bar on the lower left frame of each page and select Upload File. Follow the instructions on the Upload File page (ignore the file size warning for now, and proceed). Only certain file formats are allowed. (Send email to hpsigadmin@evanspeck.com if you want an additional file format allowed.) Once uploaded, you can inspect the files using the Special pages> File List option.
Linking
To link to an uploaded file from a project page, use the following syntax on the project page (while in edit mode).
[[Media:filename.ext optional_page_text_description]] for non-image files, or
[[Image:filename.ext optional_page_text_description]] for image files with extensions .jpg or .png.
Creating Hyperlinks
Internal Links (within the Wiki pages)
Links to another wiki page within the same wiki site (i.e., hpsig.com) are created by using double brackets around the name of the page you want to reference or create.
While it edit mode on the page from which you want to create the link, type [[the_name_of_the_target_page]] and then save the page. When you click on the link for the first time, Wiki will create the page for you.
If you want to link to an already created page, follow the same directions above, placing the name of the page within the double brackets. When you click on the link it will take you to the page, which you can view or edit.
External Links (to other web sites)
External links can be created one of two ways. The first is the typical URL, which you can type into the page while in edit mode. For example, to link to Google, simply type http://www.google.com. The hyperlink in the page (once you save the page) will appear exactly as it was entered and look like this: http://www.google.com.
The second method allows you to add a description of the link. Use single brackets and add the description of the hyperlink immediately following the hyperlink itself, e.g., [http://www.google.com Google Search]. The link will appear like this: Google Search
If you see a link that you would like to copy, simply put the wiki page in edit mode and look at how the author made the link.
Receiving Wiki Changes via RSS Feed
To try out the concept of RSS Feeds
- Go to the popular US Health Policy Journal Website Health Affairs RSS Pageand follow the instructions to set up an RSS Headline Feed from that site.
- Download an RSS Reader (we selected JetBrains Omea Reader 2.1 and found it better than FeedReader 2.9)
Firefox also has an RSS Feed extension Wizz Reader (which also works with Macs) and there is an Internet Explorer plug-in at http://www.pluck.com but I prefer a standalone window instead of the browser. There are many others to choose from....
- Set up the Health Affairs RSS Feed as they specify
To RSS Feed Wiki Recent Changes
- Subscribe to the following RSS Feed: http://www.hpsig.com/rss/feeds.php?feed=recentchanges
To get an RSS Feed of your Watchlist
- Subscribe to the following RSS Feed: http://www.hpsig.com/rss/feeds.php?feed=watchlist
Subscribe to the following RSS Feed: http://www.hpsig.com/rss/feeds.php?feed=watchlist&username=YourUsername
- Subscribe to the following RSS Feed: http://www.hpsig.com/rss/feeds.php?feed=watchlist
YourUsername should be the same as the username that you have chosen for this Wiki, case sensitive and with spaces (if any)
Navigating What's Been Done With SD in Health
Searching
You can search the list of "What's Been Done With SD in Health" from this Search Page. Check only the "WhatsBeenDone" box and enter your search phrase. The search will return any pages with a title matching your search phrase, and pages with your search phrase in the text.
Viewing Pages in "WhatsBeenDone"
You can view all the pages under the heading of "Whats Been Done With SD in Health" from this page. From the listbox, select "WhatsBeenDone" and hit "go" - Leave the text box blank. This will give a listing of all pages in the "WhatsBeenDone" category.
Adding a Page
To add a page into the "WhatsBeenDone" namespace, it is beneficial to write the page in the (main) namespace and then move it to the "WhatsBeenDone" namespace. This will allow users to search for the page in both (main) and in "WhatsBeenDone" namespaces.
Add a page in the Health SD Wikipedia under the "What's Been Done With SD in Health" heading. One way to do this is by editing the section and adding a link to your new page. Once you have saved your changes, return to the Health SD Wikipedia page and click on the link you've made - this will return a new blank page for you to edit. Once you have written your text, click the "move" tab. Move your page to the "WhatsBeenDone" namespace by prepending the title of your page with "WhatsBeenDone:", ie, if your page was called mypage then your moved page will be called WhatsBeenDone:mypage.
Check to see if your page has been moved correctly by viewing the listing of the "WhatsBeenDone" namespace (instructions above).
