Contribution Guidelines
The Cord Suit is an open Wiki, which means that anyone can edit and update the content of the website. The theory is that this will allow the site to develop and grow more quickly. If you notice a new David Berman interview, hear some news, or feel like typing in some song lyrics, please have a go at updating the site yourself. This page contains some basic instructions and an off-site link to more complete documentation.
Editing a Page
You can edit any page by clicking on the Edit link at the bottom. The content of the page will be displayed in a textbox. You can then add new content or edit the existing content. The content is basically plain text with some special rules that govern the formatting. The most common are:
- Surrounding text in "==" creates a sub-heading.
- Starting a line with : indents the line
- Starting a line with * creates an entry in a bullet point list
- Starting a line with # creates an entry in a numbered list
- Ending a line with `\\` creates a line-break instead of a new paragraph.
- Writing an entire URL, including the "http" part, creates a hyperlink.
When you are finished editing the content, you must type into an input box a sequence of five characters that will be displayed at the top right of the page. This is a security measure to prevent spam content from being inserted automatically. After this you can click the Save button to save your changes. You can also preview your changes beforehand, by clicking the Preview button.
If you would like to try out editing a page, please experiment with the Sandbox page. Once you are confident, feel free to begin updating the main pages of the Corduroy Suit. A good way to learn more about the formatting rules is to look at the content of other pages on the site, by clicking the Edit link.
The Corduroy Suit is built using the WikiTikiTavi software. Further documentation about formatting rules, including how to produce tables and reference images, is available here:
Adding a new page
To add a new page, first edit the page that you want to link to your new page. For example, to add a new song lyrics page, first edit the page for the record containing the song. You need to insert a new WikiWord, which will link to the new page.
A WikiWord is a specially word within the page content that tells the Wiki software to create a link. There are two forms of WikiWord:
- StandardWikiWord - a sequence of words, each starting with a capital, squeezed together by removing the separating spaces.
- ((Free Link)) - A sequence of words surrounded by double brackets.
The ((Free Link)) form is preferred in the Corduroy Suit and should always be used unless there is a good reason not to.
So, for example, to add the song lyrics for Random Rules, you would edit the American Water page, and change the song name from:
- Random Rules
into:
- ((Random Rules))
When you save your changes, you will notice that the WikiWord that you inserted is displayed on the page with a "?" link afterwards. You must now click on the "?" link in order to create the new page. This will take you to a page allowing you to add the content for the new page. Once you are finished, save the content, and your new page will be added to the Cord Suit.
Naming Conventions
WikiNames must be unique, so some care must be taken with naming. The following conventions should be followed:
- The WikiWord for song lyric pages should be the full song title. For example, ((Random Rules)).
- The WikiWord for a guitar chords page should be the full record title with "Guitar Chords" at the end. For example, ((Bright Flight Guitar Chords)).
- The WikiWord for a reviews page should be the full record title with "Reviews" at the end. For example, ((Bright Flight Reviews)).
- The WikiWord for a discograpy record page should be the full record title unless the record title is the same as a song title. In this case, add the word "Single" or "Album" or similar to the end of the TwikWord. For example, the Tennessee single WikiName is ((Tennessee Single))', while the song lyrics name is ((Tennessee))'.
Please feel free to add new naming conventions here as and when new types of page are created.
Further Documentation
The full documentation for WikiTikiTavi is available here: