Click on the google icon, and then select your Kwartzlab google account in order to login or create a new account. If you try to manually enter the username and password it won't work.
Guidelines have purposely been made fairly lax to encourage as much content creation as possible. We can clean it up as we go.
The number one rule of wiki editing is to be bold. Go ahead - make changes. Other people can correct any mistakes you make, so have confidence, and give it a try! There are all kinds of editing conventions, rules, and philosophies for the editing of wiki pages, but the be bold rule is the most important of these!
An edit can contribute whole new paragraphs or pages of information, or it can be as simple as fixing a typo or a spelling mistake. In general, try to add or edit text so that it is clear and concise. Most importantly, make sure you are always aiming to do something which improves the contents of the wiki.
When you need to use some type of formatting, such as for new headings or bolding of text, you do this using wiki syntax or the buttons in the edit toolbar above the editing zone. See [Help:Formatting] for some of the common types of formatting used.
- Click the New Page button (often a "+" icon) usually found in the top-right corner.
- You'll be prompted to enter a path (e.g.,
/guide/pages/newpage; folders are inferred automatically) and a title, description, and tags.
- Select your preferred editor when creating the page. Note: As of now, you generally cannot change the editor type after the page is created without a conversion action.
- Click the Create button to start adding content.
- Only super editors can create new pages. However if you create a link in an existing page to a new page (just enter in what you think the address should be, see below for tips on how paths work) then it will create a link in that page but it will be read. And a Super Editor can see that and create the new page for you.
- Click the Pencil icon or use the Page Menu (usually in the bottom-right or top-right corner).
- The page will open in the editor selected during creation.
- Make your changes using the editor's toolbar for formatting, inserting links, or adding assets.
- Click Save or Update to publish your changes.
- Wiki.js uses paths (URLs) rather than a traditional folder system. Entering a path like
/areas/cnc-router automatically structures the page under "areas"
- When creating paths always use lowercase for everything, and connect words with a dash like this: cnc-router
- Tags can be used to categorize pages and facilitate searching for related content.
- There are two ways to create a link to another page
- The icon between the special characters icon and the link icon is called "Insert Link to Page". If you select this you can navigate to the page you are trying to link to. Just verify that the link path at the bottom is correct before clicking select
- The other option is to click the link icon. You have to manually enter the path, in order to link to another page you have to add a / before the path: /areas/cnc-router If you don't add that link it won't link properly to that page
- If you create a link to a page that doesn't exist. And then click on that link, it will take you to an error page, but you can select “Create Page” at the bottom. This is a super easy way to create new pages. However only Super Editors can create new pages.
- External links are inserted using the link tool. Just make sure to include the Http:// in your link (eg http://www.kwartzlab.ca)
- Only super editors can create new pages. However if you create a link in an existing page to a new page (just enter in what you think the address should be) then it will create a link in that page but it will be read. And a Super Editor can see that and create the new page for you.
- Visual Editor (this is the main editor we should be using!)
- This is a rich-text editor, much like a standard word processor.
- It offers a toolbar with buttons for formatting text (bold, italics), creating lists, inserting tables, and managing links and images.
- This is recommended for users without knowledge of markup languages.
- Markdown Editor (this is really only for more advanced users or when we need to alter the code)
- This editor uses Markdown syntax (e.g., using
*bold* or **bold** for emphasis).
- It provides a preview of how the rendered page will look.
- It is generally preferred by developers and technical writers.
- Media Assets: You can upload images and documents (assets) via the editor's toolbar using the "Insert Assets" option. Uploaded assets must follow specific naming restrictions (no spaces, no uppercase letters, etc.).
- Page History: Wiki.js automatically takes snapshots of pages, allowing you to view the version history and revert to a previous version at any time.
- Permissions: Administrators can assign users to groups to control who can edit, create, or manage pages and assets.
For a complete beginner's guide on the basics, refer to the Wiki.js Basics guide
The Kwartzlab Wiki is divided into multiple sections:
- Everything should live within these sections.
- Within these sections are a variety of pages. These are the main pages of the Wiki
- There is one more path level below that for specialized pages.
- Do not create any pages that would live on a fourth path level
- Pages on level 3 are referenced from pages in level 2 and will not appear in the Nav menu on the left
- Remember that kwartzlab's Code of Conduct applies to wiki content as well. Don't include hurtful/discriminatory things, don't wantonly trash others' work (however, some amount of re-writing of other people's work is bound to happen while we figure out a consistent style)
- Feel free to create links to pages that don't exist. This will create a red link, which someone will hopefully see and fill in.