The project wiki is part of the SimTk wiki farm and it is intended to facilitate collaborative development of scientific content. In this page, the team members can find brief instructions to facilitate their use of the wiki within the context of project requirements. Members of the project have full permissions to read, write, revert and delete pages. Appropriate links are provided for more detailed help on this specific wiki installation, which is based on MoinMoin.

DON'T BE SHY! Start editing. It is IMPORTANT for team members to use the wiki, because

Contents

  1. Wiki Organization
    1. Page Layout
    2. Content Organization
  2. Searching the Wiki
  3. Tracking Wiki Activities
    1. Overall Wiki Activity
    2. Page Activity
    3. Subscriptions & Notifications
  4. Creating Pages
  5. Editing Pages
    1. Formatting
    2. Links
    3. Attachments
    4. Images
    5. Equations
  6. Helpful Links

Wiki Organization

Page Layout

page_layout.png

Page Header. Displays the title of the page on the left. Clicking on the title lists other wiki pages linking to the current page. On the right, links to the main SimTk wiki area and the front page of the project can be found.

Navigation Bar. This region provides links to the front page of the project, recent activities in the wiki, search page, and wiki help in that order. The last tab on right is the current page, whereas all the other links remain the same, regardless the visited wiki page.

Actions Toolbar. This toolbar is page-specific and provides links to:

Page Contents. The contents of the wiki page follows the actions toolbar.

Search Box. Provides keyword search on the wiki constrained to wiki page titles (Titles) or full content (Text).

Content Organization

Wiki is a dynamic and collaborative content generation platform. While there are not any rigid rules on the organization of content, a few guidelines may help team members to start creating pages related to their role and activities in the project:

It is advised to routinely search the wiki for content and track activities on individual pages as well as the whole wiki (see sections below).

There is no right or wrong way to organize the contents. Just do it! If someone does not like it, they can change.

Searching the Wiki

The wiki provides a powerful search mechanism to find pages of interest. Before you create a new page, it will be wise to search for similar pages to see if the informations is already in the wiki. Searches on the whole wiki site can be conducted using the following mechanisms:

For explanation of search functions, please refer to HelpOnSearching.

Tracking Wiki Activities

Overall Wiki Activity

RecentChanges page lists recent editing activities in the wiki in a chronological order (most recent first). This page is a good starting point for a summary of the evolution of the wiki site and contributions to individual pages by all team members. Items in the list include the name of the edited page (with relevant link to it), the team member who changed the page and brief comments. RecentChanges can be accessed through the link at the navigation toolbar.

Page Activity

Editing activity on individual pages can be accessed through the 'Info' link at the actions toolbar. The list provides the revision history, including the time stamp of the update, the editor, comments, and various action links, e.g. view, to access a desired revision. The 'Diff' button permits side-to-side comparison of different versions.

Subscriptions & Notifications

It is advised that all team members subscribe all wiki pages to receive e-mail notifications whenever a member changes the wiki. Subscriptions will facilitate awareness to project progress and member contributions. This can be accomplished by:

A team member may subscribe to only desired pages by going to the page and following the 'Subscribe' link at the actions toolbar.

Creating Pages

The most natural way to create a page seems to be:

  1. In an already existing page, create a link to the new page.
  2. Follow that link to select from variety of page templates or to create a new empty page.

Use concise but specific page names. It is advised to name new pages in camel case, without any spaces (all initials of the words uppercase, the remainder lower). With this convention, when the page is typed in a wiki page, it will automatically be linked. For example, typing 

ThisIsMyNewPage

while editing an existing page will create the link

ThisIsMyNewPage

When the page does not exist, the link will be shown in gray. Following this link will give the message:

This page does not exist yet. You can create a new empty page, or use one of the page templates.

Some useful templates, in terms of security, include the following, from most restrictive to most permissive:

  1. OnlyProjectMembersTemplate -- Only team members can view and edit this page. It may be wise to use this as default.

  2. SimtkReadTemplate -- Any Simtk.org registered user can read the wiki page. Only team members can edit the page.

  3. PublicReadTemplate -- Anyone can read the wiki page. Only team members can edit the page.

  4. PublicWriteTemplate -- Anyone can edit this page. Deletes and reverts are limited to team members.

Team members are encouraged to use PublicReadTemplate to allow everyone read access to our work.

If a new page name not conforming to camel case convention is desired, the link can be established as: 

["This is my new page"]

This is my new page

For other ways to create a new page, please consult HelpOnPageCreation.

Editing Pages

Pages can be edited by selecting the 'Edit (Text)' or 'Edit (GUI)' links in the actions toolbar. While 'Edit (GUI)' provides an easy to understand user interface for formatting, 'Edit (Text)' seems to be faster, with the disadvantage of the requirement to learn wiki markup language. This section will mostly focus on the text based editing mode. MoinMoin also provides comprehensive documentation for editing wiki pages, which can be accessed through:

Team members are encouraged to consult these sections and practice various editing features in the WikiSandBox.

Formatting

Text formatting is conducted through a variety of buttons in the graphical user interface ('Edit (GUI)'). In text mode ('Edit (Text)'), one can find a short guide immediately under the edit box, in a shaded area. This guide is also provided in here: 

Emphasis
    ''italics''; '''bold'''; '''''bold italics'''''; 
    ''mixed '''bold''' and italics''; ---- horizontal rule. 
Headings
    = Title 1 =; == Title 2 ==; === Title 3 ===; 
    ==== Title 4 ====; ===== Title 5 =====. 
Lists
    space and one of: * bullets; 1., a., A., i., I. numbered items; 
    1.#n start numbering at n; space alone indents. 
Links
    JoinCapitalizedWords; ["brackets and double quotes"]; url; [url]; [url label]. 
Tables
    || cell text |||| cell text spanning 2 columns ||
    no trailing white space allowed after tables or titles.

For more detailed instructions, see HelpOnFormatting.

A wiki page can be linked directly by typing its name, if its name follows the camel case convention (initials uppercase, no spaces), e.g. 

WikiPageLink

WikiPageLink

Otherwise, the page name should be within double quotes inside square brackets: 

["wiki page link"]

wiki page link

External web addresses are automatically linked, when their addressed is directly typed in page contents: 

https://simtk.org

https://simtk.org

More elaborate ways of linking can be found in HelpOnLinking.

Attachments

The most natural way to attach a file to a page seems to be:

  1. Create a link to the attachment.
  2. Following that link to upload the file.

To establish a link to an attachment in a page, type: 

attachment:filename.ext

If the file has not already been uploaded, it will provide the link in the page as:

filename.ext

Following the link will open the 'Attachments' section of the wiki page where the file can be selected and uploaded. The file will be automatically renamed to that given while providing the link.

The 'Attachments' link in the action toolbar of the wiki page can be followed directly to attach files to the page. It should be noted that a link to those attachments will not appear on the wiki page and still need to be created by the editor.

Images

Inserting images into a wiki page is the same as attachments. For example, a link to the image, given as 

attachment:openknee-logo.png

will allow you to upload an image. Once uploaded, the wiki will show the image directly on the page (rather than as a link provided for attached files):

openknee-logo.png

The wiki supports images of the format .gif, .jpg, and .png.

To have more control on the way image is displayed, one can use the ImageLink macro, e.g., 

[[ImageLink(openknee-logo.png, width=50, alt=Open Knee Logo)]]

Open Knee Logo

Equations

This wiki installation supports typesetting of equations using latex(\LaTeX).

For standalone equations, use latex(\LaTeX) commands as: 

{ { {#!latex
Insert Equation Here
} } }

Remove spaces between { { { and } } }!

For example, typing 

{ { {#!latex
\begin{displaymath}
\mathbf{X} =
\left( \begin{array}{ccc}
x_{11} & x_{12} & \ldots \\
x_{21} & x_{22} & \ldots \\
\vdots & \vdots & \ddots
\end{array} \right)
\end{displaymath}
} } }

Remove spaces between { { { and } } }!

while editing the page, inserts the equation to the page as:

\begin{displaymath} \mathbf{X} = \left( \begin{array}{ccc} x_{11} & x_{12} & \ldots \\ x_{21} & x_{22} & \ldots \\ \vdots & \vdots & \ddots \end{array} \right) \end{displaymath}

If an equation is desired in line with text, type latex(\LaTeX) commands in the parenthesis 

[[latex(Insert Equation Here)]]

[[latex($E=mc^2$)]]

produces latex($E=mc^2$).

For more details of latex(\LaTeX) support in MoinMoin, refer to http://johannes.sipsolutions.net/Projects/new-moinmoin-latex. Information on latex(\LaTeX) can be found at latex-introduction.pdf.

Helpful Links

InstructionsForWiki (last edited 2016-05-04 22:09:48 by localhost)