Working With Wikis

How to Edit Pages

Anyone with Editor rights can create a new page or edit an existing page in this wiki. 

Click on the Edit button on the right to edit the page. If you do not see the Edit button, you are probably not logged in. If you need an Cloudron account to log in, please contact Joachim.

Important: This is a co-creation space, so others will be able to review and edit your content. If you see this warning: 

XYZ started editing in the last 60minutes and to be careful not to overwrite each others updates. 

Do not edit the page and come back later (or contact the person currently editing the page). Otherwise your edits might be overwritten by the person who saves it last. For those currently editing pages, please save them as soon as you are done and don't leave them open (in a draft mode).

To leave any comments on the page, just mention them as italics on the page with your initials - JS

To update the Editorial status of a page, edit the page and click on the tag button (top right , see below) and type in one of the follwoing:

Then we can search for all of them using this query [=drafted] (for drafts) - click here to see this in action - https://guide.hypha.earth/search?term=%5B%3Ddrafted%5D

image-1618343465723.png

 

To sort pages into a different order, go back to the book or chapter view and click on the "Sort" button on the right. This will allow you to rearrange all chapters or pages in a new order. Don't forget to save the order (Click on the Save Order button at the very bottom of the form). 

image-1618142386461.png

To track any revisions of your page (done by you or others), click on the "Revisions" link on the right of the page. You will see a screen like the one below, click on any entry to see what has changed on the page (text highlighted in red=removed, green=updated). If you restore a previous version, you will loose the edits between the current and the restored version. 

image-1618089610406.png

To add some additional highlights to pages, use the following under Formats > Callouts or Blockquotes:

Everyone is good to go.

There is some danger using this technique!

This is some more information..

This is an important message 

This is an important quote that helps to underline the text. This is an important quote that helps to underline the text. This is an important quote that helps to underline the text. This is an important quote that helps to underline the text. " -Fuller

To add structure to pages, see the dropdown in the editor called Formats and the sample below. Once you assign different headings, they will structure the content of the page and allow you to use a page navigation tool (on the left below). Don't worry about the formatting of the headers for now, we can change this for all pages in the Custom HTML Head Content section. 

image-1618255920409.png

For more help, please visit the BookStack help documentation

How to Embed Media

<iframe title="Notepad" 
  style="width: 100%; height: 450px;" // use 508px for docs
  src="YOUR URL GOES HERE" >
</iframe>

 

 

How to Print Content

Prepping

  1. The TOC is generated automatically by BookStack but is placed in front. Hence you need to copy and paste that content into a new page after the cover page. All links will be preserved in the process. 

Printing

  1. In the wiki, go to the full page structure at https://guide.hypha.earth/books/the-chronicles-of-samara
  2. Click on Export on the right and select Contained Web File.html (this wil download an XHTML file)
  3. Open the file in Chrome
  4. Print the file and save as PDF (start with the cover page)
  5. Convert the XHTML into MOBI or ePUB or other formats at https://convertio.co/ 

How to Structure Content

Miro Board

Notepad

How to use the API

https://guide.hypha.earth/api/docs 

Example: https://guide.hypha.earth/api/pages/3