Author Tips

This page contains helpful tips and conventions for Audiobus Wiki contributors. Please give it a quick review.

Want to get deeper? There are more articles related to Audiobus Wiki authoring here. These articles include tutorials about particular authoring tasks and information about non-basic features that are available to wiki authors.

SEE ALSO: contributor guidlines

Links to wiki and external pages are easy to create by typing manually or by using the handy tools in the editing toolbar.

Manual Links. To create a link, enclose either a URL or a wiki page name in doubled square brackets [[pagenamehere]]. To have a link title appear instead of the page name or URL, use this syntax [[pagenamehere|Text You Want to Appear]]. For example, use [[author_tips|Tips for Authors]] to create a link to this page: Tips for Authors

For pages on this wiki, please use local links rather than URLs.

To create a new page with the Add New Page tool: click on the Add New Page icon that appears in the page header and enter a page name. The actual location and appearance depends on the device and browser.

To create a new playground page: click on the Add New Page icon and type “playground:mynewpage”. This will create the page in the playground which is a holding area for pages not yet ready for the main wiki and for experimenting.

Creating new pages from links: it can be convenient to create a link to a page you plan to create. When you are viewing a page with a link to a non-existent page, clicking on the link gives you a chance to create it. For example, you might enter [[myUncreatedPage|a page I plan to create]]

By convention, Dokuwiki pages should have a heading at the top of the page followed by some introductory or summary text. The headline should serve as the article title. This convention is somewhat different from what one finds on Wikipedia (for example), but following this convention helps Dokuwiki build nice looking/readable indexes and tables of contents. Just press the leftmost headline button when you first create a page and type your page's preferred title. For example:

====== Synth History 101 ======
A short history of modern synthesis techniques

You can add tags to wiki pages by adding the following to the bottom of a page. Separate each tag with a space:

{{tag>[list of tags]}}  

Multi-word tags. You can create tags with spaces in them by using double-quote to enclose the tag, but think twice before using a multi-word tag.

Important Guideline

When tagging pages, don’t go overboard with tags. Generally, pages will only need a few tags at most. Using too many tags on pages can make tag indexes less meaningful. For example, if AUM is mentioned on a page but the page is really about something else, it doesn’t need to be tagged with AUM.

Visitors can do searches using words, too. So, one doesn’t need to tag every word of possible interest. Only tag the most key topic or category. People mostly will search by word.

Think of tags as a targeting tool that prevents too many search results or as aids to find pages that might not be found when searching by word.

To embed a YouTube video the most basic syntax is:

{{youtube>myVideoId?small}}

where myVideoId will be the actual video id of the YouTube video. “?small” sets the size of the clip in the browser. The small size works well across devices. You can leave off “?small” entirely or use another size option.

The ID is going to be something like L-WM8YxwqE. Make sure that there is no space between the > character and the first character of the video id. Pasting a copied id sometimes introduces a space character that will cause the link to fail.

You can also embed video content from other popular sites, too.

There are additional options described on the vshare plugin home page.

If you want more help there’s a step by step tutorial.

By default, Audiobus Wiki pages have a table of contents (TOC) that appears at the top of each page. The The TOC is built from the page's headings. Sometimes, this TOC is unnecessary. To suppress it, add the following text at the top of a page.

~~NOTOC~~ 

If you need to delete a page, just edit it, then erase the contents and save.

If you want text that would normally be “wiki-ized” to actually appear on the page, surround it with the tags

<nowiki>{{don’t wiki me> more stuff}}</nowiki>

Or, simply enclose the text with double percent signs %%

This is handy if you need to display syntax that would normally be wiki-ized.

You can also precede a line with two spaces to have the wiki format it as “code” and ignore wiki syntax.

If you want to upload files other than images, Audiobus presets or Audiobus controller profiles, and the uploader is rejecting the file type, you'll need to either contact Michael or package the file in a zip.

The WRAP tag can be used to extend Dokuwiki's native text formatting.

To indent a block of text, wrap the text with the WRAP tag and indent flag:

<WRAP indent>some text to indent</WRAP>

some text to indent

It can do a lot more than just indenting, too. More information about WRAP can be found here.

It is impossible to embed SoundCloud track players. See the page Embedding SoundCloud Players

  • author_tips.txt
  • Last modified: 2019/05/22 03:27
  • by espiegel123