author_tips

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
author_tips [2019/05/09 05:41] espiegel123author_tips [2020/02/07 06:53] (current) – Updated tags _ki
Line 1: Line 1:
 ====== Author Tips ====== ====== Author Tips ======
 +This page contains helpful tips and conventions for Audiobus Wiki contributors. Please give it a quick review.
  
-This page contains helpful tips and conventions for Audiobus Wiki contributors.+Want to get deeper? There are more articles related to Audiobus Wiki authoring [[wiki:|here]]. These articles include tutorials about particular authoring tasks and information about non-basic features that are available to wiki authors.
  
-===== Page Links =====+SEE ALSO: [[wiki:contributor guidelines|contributor guidlines]] 
 +===== Creating Page Links =====
  
 Links to wiki and external pages are easy to create by typing manually or by using the handy tools in the editing toolbar. Links to wiki and external pages are easy to create by typing manually or by using the handy tools in the editing toolbar.
Line 11: Line 13:
 **For pages on this wiki**, please use local links rather than URLs. **For pages on this wiki**, please use local links rather than URLs.
  
 +===== Creating New Pages =====
 +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 [[wiki: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 <nowiki>[[myUncreatedPage|a page I plan to create]]</nowiki>
 ===== Page Structure ===== ===== Page Structure =====
  
Line 32: Line 40:
  
 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. 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.
- 
-===== Table of Contents Suppression ===== 
-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~~  
  
 ===== YouTube Embedding ===== ===== YouTube Embedding =====
Line 42: Line 45:
 To embed a YouTube video the most basic syntax is: To embed a YouTube video the most basic syntax is:
  
-  {{youtube>L-WM8YxwqEU}}+  {{youtube>myVideoId?small}}
      
-You can also embed video content from other popular sites, tooThere are additional options which you can read about [[https://www.dokuwiki.org/plugin:vshare|here]]+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 [[https://www.dokuwiki.org/plugin:vshare|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 [[https://www.dokuwiki.org/plugin:vshare|vshare plugin home page]]. 
 +
 +If you want more help there’s a [[wiki:embed_youtube|step by step tutorial]].
 +===== Table of Contents Suppression =====
 +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~~ 
 +  
 ===== Deleting pages ==== ===== Deleting pages ====
 If you need to delete a page, just edit it, then erase the contents and save. If you need to delete a page, just edit it, then erase the contents and save.
Line 52: Line 67:
 If you want text that would normally be "wiki-ized" to actually appear on the page, surround it with the tags 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>   <nowiki>{{don’t wiki me> more stuff}}</nowiki>
 +
 +Or, simply enclose the text with double percent signs ''<nowiki>%%</nowiki>''
  
 This is handy if you need to display syntax that would normally be wiki-ized. 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. You can also precede a line with two spaces to have the wiki format it as “code” and ignore wiki syntax.
-===== Wiki Author Tutorials ===== 
-[[https://wiki.audiob.us/wiki_author|Tutorials for and by Wiki Authors]] 
- 
 ===== Uploading Files ===== ===== Uploading Files =====
  
 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. 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.
  
-{{tag>authoring tutorial}}+===== Indenting (WRAP) ===== 
 + 
 +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> 
 +  
 +<WRAP indent>some text to indent</WRAP> 
 +   
 +It can do a lot more than just indenting, too. More information about WRAP can be found [[https://www.dokuwiki.org/plugin:wrap|here]]. 
 +===== Soundcloud Player Embedding ===== 
 +It is impossible to embed SoundCloud track players. See the page [[wiki:Embedding SoundCloud Players|Embedding SoundCloud Players]] 
 + 
 + 
 + 
 +{{tag>wiki_authoring}}
  • author_tips.1557344478.txt.gz
  • Last modified: 2019/05/09 05:41
  • by espiegel123