Differences

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

Link to this comparison view

Next revision 		Previous revision
wiki_formatting_guidelines [2019/01/17 09:21]
127.0.0.1 external edit 		wiki_formatting_guidelines [2020/11/06 15:05] (current)
shendrix
Line 1: Line 1:
  
 +====== Control WIKI Guidelines ======
  
- +This page provides recommended formatting guidelines when using a Control WIKI.
- +
-This page provides recommended formatting guidelines when using a Cyrious WIKI. +
- +
  
 ===== Helpful Info ===== ===== Helpful Info =====
-  * [[summary_of_wiki_formatting_commands]] +  * [[wiki:syntax|Wiki Formatting Syntax]] 
-  * [[microsoft_word_macro_to_reformat_for_wiki]]+  * [[https://www.screencast.com/t/blTohbzJcVfe|Getting started tutorial]]
  
  
 +===== Template =====
  
-===== Cyrious WIKI Guidelines =====+<code>
  
 +Page Name
  
 +Description
  
-==== Template ==== +Topic 1 
- +  - Item 1 
- +  - Item 2
- +
-Use this template for all new pages (unless you have a better one)...+
  
 +  Steps
 +    1. Step 1
 +    2. Step 2
  
 +See Also
 +  * Links [link to a relevant wiki]
  
 </code> </code>
  
  
 +=== Example ===
  
-={$page}= +<code> 
- +====== How to launch Control ======
- +
- +
-Description ... +
- +
- +
- +
-==Topic 1== +
-  * Item 1 +
- +
- +
- +
-==See Also== +
-  * Backlinks [[include_pagepage_componentbacklinks|include_pagepage_componentbacklinks|include page="{$page}" component="backlinks"]]+
  
 +====== Description ======
 + This article will walk through how to launch Control.
  
 +=== Steps ===
 + Please follow these steps on your PC.
 +    - Double click the shortcut for Control on your desktop.
 +    - Select your Login name from the dropdown
 +    - Type in your password
 +    - Press the Enter key.
  
 +See Also
 +  * Links: [[http://support.cyriouswiki.com/|Cyrious Technical Support]]
 </code> </code>
  
 +====== Using the Text Editor ======
  
 +The Native DokuWiki Editor (DW Edit) is a quick and easy way to build or make changes to a wiki. The [[wiki:syntax|Wiki Formatting Syntax]] is a helpful resource for formating text, code snippets and hyperlinking to other resources.
  
-==== Put WIKI Pages Name as Heading 1 ==== +Using a text editor like Visual Studio Code, Notepad++, etc is recommended as a workspace. These text editors offer auto-save options that will help prevent any loss of work. They also allow a much larger workspace, spell checking plugins, etc. Once finished with the editing, copy the text into the DW Editor and save the changes.
- +
- +
- +
-Start all WIKI pages with +
- +
- +
- +
-<html><div style="margin-left: 40px;"> ``={$page}=`` </div></html> +
- +
- +
- +
-This makes the first heading the name of the page ( {$page} can be used anywhere to insert the current page name ). +
- +
- +
- +
-==== Table Of Contents ==== +
- +
- +
- +
-For any WIKI page that does not fit on a single screen viewing (requires scrolling), insert a table of contents near the top. +
- +
- +
- +
-<html><div style="margin-left: 40px;"> ``[[toc|toc]]`` </div></html> +
- +
- +
- +
-It must be on a line by itself. I usually put it right after the first paragraph of the description. +
- +
- +
- +
-==== Backlink Every Page ==== +
- +
- +
- +
-Include a list of back-links on every page by inserting this text at the end of every page: +
- +
- +
- +
-<html><div style="margin-left: 40px;"> ``==See Also==`` </div></html> +
- +
- +
- +
-<html><div style="margin-left: 40px;"> ``* Backlinks [[include_pagepage_componentbacklinks|include_pagepage_componentbacklinks|include page="{$page}" component="backlinks"]]`` </div></html> +
- +
- +
- +
-Add any other relevant links before the backlinks. +