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
wiki_formatting_guidelines [2020/11/06 14:00]
shendrix
wiki_formatting_guidelines [2020/11/06 15:05] (current)
shendrix
Line 1: Line 1:
-This page provides recommended formatting guidelines when using a Cyrious WIKI. 
  
-===== Helpful Info =====+====== Control WIKI Guidelines ======
  
-  * [[:wiki:syntax|Formatting Syntax]] +This page provides recommended formatting guidelines when using a Control WIKI.
-  * [[:microsoft_word_macro_to_reformat_for_wiki|]]+
  
-===== Cyrious WIKI Guidelines ===== +===== Helpful Info ===== 
- +  * [[wiki:syntax|Wiki Formatting Syntax]] 
-==== Template ==== +  * [[https://www.screencast.com/t/blTohbzJcVfe|Getting started tutorial]]
- +
-Use this template for all new pages (unless you have a better one)… +
- +
-={$page}= +
- +
-Description … +
- +
-== Topic 1 ==+
  
-  * Item 1 
  
-== See Also ==+===== Template =====
  
-  * Backlinks [[:include_pagepage_componentbacklinks|]]+<code>
  
-==== Put WIKI Pages Name as Heading 1 ====+Page Name
  
-Start all WIKI pages with+Description
  
-<html><div style="margin-left: 40px;"> ``={$page}=`` </div></html>+Topic 1 
 +  Item 1 
 +  - Item 2
  
-This makes the first heading the name of the page ( {$page} can be used anywhere to insert the current page name ).+  Steps 
 +    1Step 1 
 +    2. Step 2
  
-==== Table Of Contents ====+See Also 
 +  * Links [link to a relevant wiki]
  
-For any WIKI page that does not fit on a single screen viewing (requires scrolling), insert a table of contents near the top.+</code>
  
-<html><div style="margin-left: 40px;"> ``[[toc|]]`` </div></html> 
  
-It must be on a line by itself. I usually put it right after the first paragraph of the description.+=== Example ===
  
-==== Backlink Every Page ====+<code> 
 +====== How to launch Control ======
  
-Include a list of back-links on every page by inserting this text at the end of every page:+====== Description ====== 
 + This article will walk through how to launch Control.
  
-<html><div style="margin-left: 40px;"> ``==See Also==`` </div></html>+=== 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.
  
-<html><div style="margin-left: 40px;"> ``Backlinks [[include_pagepage_componentbacklinks|]]`` </div></html>+See Also 
 +  Links: [[http://support.cyriouswiki.com/|Cyrious Technical Support]] 
 +</code>
  
-Add any other relevant links before the backlinks.+====== 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.
  
 +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.