Contributors please read the Wiki Guide!

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_guide [2017/08/31 17:48]
blue999 		wiki_guide [2020/01/16 15:13] (current)
blue999
Line 3: Line 3:
 ===== Contribution Guidelines ===== ===== Contribution Guidelines =====
  
-  * Add a summary of what you change +==== Do's: ==== 
-  * Don't make drastic changes to someone else's page without asking permission first (if possible) + 
-  * Keep your pages as consistent as possible with the rest of the Wiki+  * If you have plans to implement big changes on a certain page, discuss it on [[https://discordapp.com/invite/nDRvMXH|Discord]] first (in #wiki-discussion) 
 +  * Document your changes! Add a summary of what you've edited if possible 
 +  * Keep any text concise and easy to read. Use professional language so someone else can easily pick-up where you've left off 
 +  * Keep your pages as consistent as possible with the rest of the wiki (in layout as well as language)
   * Try to make all of your edits in as few saves as possible to avoid cluttering the history   * Try to make all of your edits in as few saves as possible to avoid cluttering the history
-  * Contact Blue999, DesuDemona, Loveless, or Innoxia on Discord for any issues/complaints/questions/feedback regarding the Wiki+  * Contact Blue999, rfpnj or monster on Discord for any issues/complaints/questions/feedback regarding the wiki 
 + 
 +==== Don'ts: ==== 
 + 
 +  * Don't make any big changes to someone else's page without consulting with them on Discord 
 +  * Try to prevent any spelling and/or grammar mistakes. Use a proofreader or autocorrect software if possible 
 +  * Do not mention any easter eggs or other secrets on the wiki (for the time being) 
 +  * Don't edit the [[:homepage|front page]] or the [[:contributor_homepage|contributor homepage]] without discussing it on Discord
  
 ===== Using DokuWiki ===== ===== Using DokuWiki =====
  
-Since many of you will be used either to Wikia or MediaWiki, I shall go over some points about using DokuWiki as Wiki Software.+Since many of you will be used either to Wikia or MediaWiki, I shall go over some points about using DokuWiki as Wiki software. 
 + 
 +==== Creating a New Page ==== 
 + 
 +In order to create a new page in DokuWiki, you have to search the location of where it will be within the [[:homepage?do|Sitemap]] and then click the "Create" button at the top right or click ALT-E. Make sure that you get the [[:wiki_guide#links_and_the_sitemap|directory correct]]. 
 + 
 +==== Paragraph Formatting ==== 
 + 
 +Similarly to both Wikia and MediaWiki, DokuWiki uses Paragraph Formatting to improve the layout and uniformity of it's pages, you can change the format of text by selecting it and clicking the drop down box which will say the current format of the text. It is paramount that you only use this for changing the size and font of text as it may cause issues otherwise. In order to maintain uniformity, use //italics//  (Ctrl A) to empthasise something. 
 + 
 +{{:wiki:paragraphformatting.png?nolink&818x200}}
  
 ==== Links and the Sitemap ==== ==== Links and the Sitemap ====
Line 19: Line 39:
 It is important you know the directories of this Wiki so that you can create links to pages which don't currently exist, directories in DokuWiki use the colon, ( : ) instead of the forward slash ( / ), however either can be used as it will automatically switch to the colon ( : ). It is important you know the directories of this Wiki so that you can create links to pages which don't currently exist, directories in DokuWiki use the colon, ( : ) instead of the forward slash ( / ), however either can be used as it will automatically switch to the colon ( : ).
  
-When creating a link on the page, if the link is external, you can simply paste the URL of the destination in the URL box in the window that opens immediately upon clicking the link button, but if you are making an internal link, click "Link Type" and choose Internal Link, you can then put the directory of the page in //instead of the URL// and what you wish the Link to appear as in the "Link Text" box.+When creating a link on the page, if the link is external, you can simply paste the URL of the destination in the URL box in the window that opens immediately upon clicking the link button, but if you are making an internal link, click "Link Type" and choose Internal Link, you can then put the directory of the page in //instead of the URL//  and what you wish the Link to appear as in the "Link Text" box.
  
 {{:wiki:linktype.png?nolink&375x350}}{{:wiki:internal_link.png?nolink&375x350}} {{:wiki:linktype.png?nolink&375x350}}{{:wiki:internal_link.png?nolink&375x350}}
 +
 +By switching to the "Advanced" tab of the Link Window allows you to create links to specific parts of a page, for example, [[:wiki_guide#links_and_the_sitemap|this link will take you to the Link and Sitemap Heading of this page]].
 +
 +The first box of the "Advanced" tab will not contain any options until you click the "Get Headings" button.
 +
 +{{:wiki:linkadvanced.png?nolink&375x350}}
  
 ==== Adding Images ==== ==== Adding Images ====
  
-Because the editor used to create and edit pages on the Wiki doesn't function perfectly, in order to upload an image to a page, //you cannot use //the in-editor image upload, it will result in the image not uploading at all. Instead, enter the Media Manager, which can be found in the Tools section of the Toolbar. In here, you can navigate to the appropriate directory for the image (The same as the page) and upload the image before editing the page. Bare in mind that in order to select files to Upload you click the "Select Files..." text and not the "Upload" button which uploads the selected images.+Because the editor used to create and edit pages on the Wiki doesn't function perfectly, in order to upload an image to a page, //you cannot use //the in-editor image upload, it will result in the image not uploading at all. Instead, enter the [[:https:www.lilithsthrone.com:dokuwiki:doku.php?id=Homepage&do=media|Media Manager]], which can be found in the "Tools" section of the Toolbar. In here, you can navigate to the appropriate directory for the image (The same as the page) and upload the image before editing the page. Bare in mind that in order to select files to Upload you click the "Select Files…" text and not the "Upload" button which uploads the selected images.
  
 {{:wiki:mediamanageruploadingimage.png?nolink&1041x300}} {{:wiki:mediamanageruploadingimage.png?nolink&1041x300}}
 +
 +===== Using the Wrap Plugin =====
 +
 +The Wrap Plugin is used on the Wiki to provide a number of functions, notably infoboxes, there are too many features of the Wrap Plugin to cover all of them in this guide, therefore please consult the [[https://www.dokuwiki.org/plugin:wrap|Wrap Plugin Documenation]]. If you are a frequent contributor and you need assistance learning how to use the Wrap Plugin, please ask Blue999 for assistance.
 +
 +Wrap makes use of the <WRAP> tag to create divs, and the <wrap> tag to create spans.
 +
 +===== Using the Abbr Plugin =====
 +
 +The <abbr>Abbr Plugin[Abbreviation Tooltip Plugin]</abbr> can be used to create tooltips like the one just shown, the Abbreviation Tooltip plugin uses the <abbr> tag, within the tags, first write the abbreviated form of the word, and then use square brackets ( [ ] ) to contain the full description.
 +
 +You may want to read the [[https://www.dokuwiki.org/plugin:abbr|Abbreviation Tooltip Plugin Documentation]] for further explanation.
 +
 +====== Further Help ======
 +
 +If you require further assistance, you can use Discord to contact either:
 +
 +  * Blue999
 +  * monster
 +  * rfpnj
 +
 +Or you might alternatively want to try using the specific help pages of DokuWiki and it's extensions:
 +
 +  * [[https://www.dokuwiki.org/manual|DokuWiki Documentation]]
 +  * [[https://docs.ckeditor.com/|CKEditor 4 Documentation]]
 +  * [[https://www.dokuwiki.org/plugin:wrap|Wrap Plugin Documenation]]
 +  * [[https://www.dokuwiki.org/plugin:abbr|Abbreviation Tooltip Plugin Documentation]]
 +  * [[https://www.dokuwiki.org/plugin:tag|Tag Plugin Documentation]]
 +  * [[https://www.dokuwiki.org/plugin:templatepagename|Template Page Name Plugin Documentation]]
  
  

Trace: