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
facilities:slq_wiki:start [2019/10/03 09:11]
Andrei Maberley [More Editing]
facilities:slq_wiki:start [2022/11/02 13:59] (current)
Michelle Brown [Adding Users]
Line 3: Line 3:
 <WRAP pagebreak></WRAP> <WRAP pagebreak></WRAP>
  
-==== Getting Around ====+===== Getting Around =====
  
-On the left you can see our navigation menu. This menu is automatically generated, and uses the page names and //namepaces// (more on namespaces later) to create the structure. +On the left you can see our navigation menu. This menu  uses the page names and //namepaces// (more on namespaces later) to create the structure. 
  
 On the right is the Table of Contents (TOC) for the page you are one. On the right is the Table of Contents (TOC) for the page you are one.
  
-Before you start editing or creating, you will need to be logged in. Please check out the Dokuwiki [[https://wiki.edgeqld.org.au/doku.php?id=wiki:syntax#formatting_syntax|syntax]]  and the [[facilities:slq_wiki:wiki_style_guide|SLQ Wiki Style Guide]].+Before you start editing or creating, you will need to be logged in. Please check out the Dokuwiki [[https://wiki.edgeqld.org.au/doku.php?id=wiki:syntax#formatting_syntax|syntax]]  and the [[facilities:slq_wiki:wiki_style_guide|SLQ Wiki Contributors Guide]].
  
-==== Exporting Content ==== +===== To Create a Page =====
- +
-You can export a PDF or ODT file of the page you are on by using the buttons in  floating tool bar on the right. +
- +
-{{  :the_edge_programming_wiki_theedge_-_2016-04-04_16.08.54.png?nolink&30  }} +
- +
- +
- +
-====Namespaces and Page Names==== +
- +
-A page in a dokuwiki is just a text file.  You can see it in the bottom right of this page - in this case its called "start.txt" The page is always the last word in the URL link to the page (provided you are not editing it).  A namespace is like a folder or section - a namespace can contain pages or other namepaces. +
- +
-===== To Edit a Page ==== +
- +
-To edit a whole page, use the edit page button  in the floating tool bar, or in the top menu. +
- +
-This will open dokuwikis built in editor…. +
- +
-{{  :the_edge_programming_wiki_theedge_-_2016-04-04_16.12.52.png?nolink&800  }} +
- +
-Dokuwiki uses simple syntax for generating HTML, somewhat like [[https://en.wikipedia.org/wiki/Markdown|markdown]] . The is easy to use, but the editor also has a built in cheat menu, where you can click and add formatting. The syntax keeps our documentation in txt format, ready to be converted to any other format imaginable.. +
- +
-You can also edit just sections of a page by clicking on the //edit// button below each section. +
- +
-==== To Create a Page ====+
  
 Creating a page is as simple as writing a link - to a page that doesn't exist....  Creating a page is as simple as writing a link - to a page that doesn't exist.... 
Line 60: Line 36:
 Now you know how to edit - its time to learn some syntax. Now you know how to edit - its time to learn some syntax.
  
-==== Dokuwiki Syntax =====+===== Dokuwiki Syntax ======
  
 For a full explanation of Dokuwiki syntax  check out [[facilities:slq_wiki:syntax|Formatting Syntax]].   For a full explanation of Dokuwiki syntax  check out [[facilities:slq_wiki:syntax|Formatting Syntax]].  
  
-===== More Editing =====+===== To Edit a Page ====
  
-Some commonly used extra functionality for the site are the [[facilities:slq_wiki:wiki_style_guide:revealjs|RevealJS]] slide show and the PDF export function +To edit a whole page, use the edit page button  in the floating tool bar, or in the top menu.
  
 +This will open dokuwikis built in editor….
  
 +{{  :the_edge_programming_wiki_theedge_-_2016-04-04_16.12.52.png?nolink&800  }}
  
- ===== Using the Include Function for Documentation =====+Dokuwiki uses simple syntax for generating HTML, somewhat like [[https://en.wikipedia.org/wiki/Markdown|markdown]] . The is easy to use, but the editor also has a built in cheat menu, where you can click and add formatting. The syntax keeps our documentation in txt format, ready to be converted to any other format imaginable..
  
-we can use the //include// plugin to insert information from one page into other pages.+You can also edit just sections of a page by clicking on the //edit// button below each section.
  
- As a first example we will modify an existing page to create a pre-production page, then we'll make a //preprod// page from scratch. 
  
  ===== Modify an Existing Page =====  ===== Modify an Existing Page =====
  
-1) I'll start with the locks prototype. Mick has helpfully made some prep-production info for use to experiment with. Lets try removing that section from the main page and //including// it from another page called preprod.+1) I'll start with the locks prototype. Mick has helpfully made some prep-production information for use to experiment with. Lets try removing that section from the main page and //including// it from another page called preprod.
  
 First up, make a page in protypes:lock using; First up, make a page in protypes:lock using;
Line 111: Line 88:
  
 {{ :lock_theedge_.png?nolink&500 |}} {{ :lock_theedge_.png?nolink&500 |}}
 +
  
  ===== Create a Pre-Production Page from Scratch =====  ===== Create a Pre-Production Page from Scratch =====
Line 116: Line 94:
 This is simpler - just create your preprod page the same as in step 1) above, and do all your pre-production documentation in there. Once its complete, use and //include// tag to insert the pre-prod information into your main page. This is simpler - just create your preprod page the same as in step 1) above, and do all your pre-production documentation in there. Once its complete, use and //include// tag to insert the pre-prod information into your main page.
  
 +
 +
 +
 +
 +===== Exporting Content =====
 +
 +You can export a PDF or ODT file of the page you are on by using the buttons in  floating tool bar on the right.
 +
 +{{  :the_edge_programming_wiki_theedge_-_2016-04-04_16.08.54.png?nolink&30  }}
 +
 +
 +
 +=====Namespaces and Page Names=====
 +
 +A page in a dokuwiki is just a text file.  You can see it in the bottom right of this page - in this case its called "start.txt" The page is always the last word in the URL link to the page (provided you are not editing it).  A namespace is like a folder or section - a namespace can contain pages or other namepaces.
 +===== Using a page as slides =====
 +
 +You can set up a page in such a way that you can also view its content as a silde deck, which is great for workshops and inductions. This is through a function called  [[facilities:slq_wiki:wiki_style_guide:revealjs|RevealJS]] 
 +
 +
 +===== Exporting a page to PDF =====
 +
 +Each page will have a button in the top right that allows you to export it to PDF. Great for printing handout notes! 
 +
 +
 + ===== Using the Include Function for Documentation =====
 +
 +we can use the //include// plugin to insert information from one page into other pages.
 +
 + As a first example we will modify an existing page to create a pre-production page, then we'll make a //preprod// page from scratch.
 +
 +
 +
 +===== Hiding Text =====
 +you can hide text from the page but keep it in the editable code by using the hide wrapper. click edit to see the code for the snippet below:
 +
 +<wrap hide> this text will not appear on the page when it's viewed, only when it's in edit mode.</wrap>
  
 ===== Using Regex to fix formating ===== ===== Using Regex to fix formating =====
Line 191: Line 206:
   {{url> http://www.example.com/somepage.html}}   {{url> http://www.example.com/somepage.html}}
  
- ===== Integrating Google Sheets ===== 
  
-The [[https://www.dokuwiki.org/plugin:csv|CSV]] dokuwiki plugin can be used to insert google sheet.  +===== Sidebars ===== 
 +Sidebars lie on the left hand side of each page and contain handy quick links and info 
 + 
 +They work in two ways, the default is that they inherit a simple list of links from their parent in the sitemap (accessed by going to tools>sitemap from that page). the list will contain everything below their parent heading (their sibling pages).   
 + 
 +But you can also edit a sidebar as you would a page. To do so, create a page called sidebar under the relevant parent page in the url/sidebar structure.  
  
-  * The sheet will updated automatically (but slowly!), +=====Images Media Manager=====
-  * links will not display in the tables this is a [[https://github.com/cosmocode/csv/issues/10|known issue]] and will not be implemented.  +
-  * Its not pretty.+
  
-As an example this sheet:+Full size images can use codes to change the orientation of an image, read more here - http://sylvana.net/jpegcrop/exif_orientation.html 
  
  
- {{ :facilities:wiki:sheet_example.png?600 |}}+===== Adding Users =====
  
-Looks like this:+The SLQ Wiki works in conjunction with the State Library's membership system - [[https://www.slq.qld.gov.au/get-involved/become-member]] 
  
 +Direct link to user login - [[https://patron.slq.qld.gov.au/Register]] 
  
-<csv file=https://docs.google.com/spreadsheets/d/e/2PACX-1vTG9f5d8SaZmNYpriWgqoEX1RhD5ZI0zaJ7qds6rYZyPU9aCWB9f93a8KX-sgEit5nrwbaD-dAuKuWp/pub?gid=0&single=true&output=csv></csv>+Once a user has become a member, they have read access to the public pages of the SLQ Wiki. 
 +If you need to add someone as a contributor so they can add pages and edit, then State Library staff can use the Updater system to add access, see below for the steps.
  
 +URL for SLQ staff - 
 +[[https://updater.slq.qld.gov.au/user/EdgeMove]]
  
 +**STEP 1:**
  
 +{{:facilities:slq_wiki:updaterwikipage.png|}}
  
-refer to the documentation for details.+**STEP 2:** 
 +{{:facilities:slq_wiki:updaterfinduser.png|}}
  
 +**STEP 3:**
 +{{:facilities:slq_wiki:updateraddaccess.png|}}
  

We acknowledge Aboriginal and Torres Strait Islander peoples and their continuing connection to land and as custodians of stories for millennia. We are inspired by this tradition in our work to share and preserve Queensland's memory for future generations.