Welcome to the Wiki!
This is the main page of your new wiki. Below is a demonstration of the formatting features available.
Standard Markdown Features
This wiki uses Markdown for formatting content. Here are some common examples:
Text Formatting
- Italic text:
*Italic text*
or_italic text_
- Bold text:
**Bold text**
or__bold text__
Codeblocks
:`Inline code span`
or``` `Backticks` ```
for literal backticks inside.
Headings
Heading 1 (equivalent to page title, usually only one per page)
# Heading 1
Heading 2 (like this section's title)
## Heading 2
Heading 3
### Heading 3
Heading 4
#### Heading 4
Heading 5
##### Heading 5
Heading 6
###### Heading 6
Lists
Unordered List
- Item 1
- Item 2
- Sub-item 2.1
- Sub-item 2.2
- Item 3
#### Unordered List
- Item 1
- Item 2
- Sub-item 2.1
- Sub-item 2.2
- Item 3
Ordered List
- First item
- Second item
- Sub-item 2.a
- Sub-item 2.b
- Third item
#### Ordered List
1. First item
2. Second item
1. Sub-item 2.a
2. Sub-item 2.b
3. Third item
Links
This is an external link to Django's website
[This is an external link to Django's website](https://www.djangoproject.com/)
Another link with a title
[Another link with a title](https://www.markdownguide.org/ "Markdown Guide Homepage")
Images
To embed images from an external URL:
(To embed images uploaded to this wiki, see the "Custom File Links" section below.)
Blockquotes
This is a blockquote. It can span multiple lines.
Nested blockquotes are also possible.
Code Blocks
For inline code, use single backticks: print("Hello, world!")
.
For a block of code, use triple backticks (fenced code blocks):
# This is a Python code block
def greet(name):
print(f"Hello, {{name}}!")
greet("Wiki User")
// This is a JavaScript code block
console.log('Hello from the Wiki!');
This is a generic code block
without language specification.
Plain text.
Tables
Header 1 | Header 2 | Header 3 |
---|---|---|
Cell 1.1 | Cell 1.2 | Cell 1.3 |
Cell 2.1 | Cell 2.2 (can have Markdown) | Cell 2.3 |
Cell 3.1 |
Cell 3.2 | Cell 3.3 |
Horizontal Rule
Three or more hyphens, asterisks, or underscores:
Custom Wiki Features
This wiki includes special syntax for easy internal linking and embedding attached files.
1. WikiLinks: [[Page Title]]
or [[Link Text | Page Title]]
Use double square brackets to link to other pages within this wiki.
Simple Link:
[[Another Page]]
- This will create a link to a page titled "Another Page". If the page exists, it links directly.
- If "Another Page" doesn't exist, the link will appear as "Another Page (create)" and will take you to the page creation form, pre-filled with the title "Another Page".
- Example: Try creating a page named
[[Sample Test Page]]
.
Link with Custom Text:
[[Click here for tips | Formatting Tips]]
- This will create a link to a page titled "Formatting Tips", but the visible link text will be "Click here for tips".
- Example:
[[Learn about our Team | About Us]]
(assuming an "About Us" page exists or will be created).
How it works: The system tries to find a page by exact title match first. If not found, it tries to find a page by a slugified version of the "Page Title".
2. FileLinks: {{{{ filename.ext }}}}
or {{{{ Display Text | filename.ext }}}}
Use double curly braces to link to files attached to the current page. These links will point directly to the file, opening in a new tab.
To use this feature:
- First, save the current page (if you're creating it or have unsaved edits).
- Then, scroll to the bottom of the page (in edit mode) to the "Attached Files" section.
- Use the "Upload New File" form to attach files. Pay attention to the "Proposed Filename (no ext.)" field as this (plus the extension) will be what you use in the
{{{{ }}}}}
tag. - Once files are attached, you can reference them in your Markdown content.
Simple File Link:
{{{{ my-document.pdf }}}}
- This will create a link displaying "my-document.pdf" that links to the attached file named
my-document.pdf
(or more accurately, the file whosefilename_slug
ismy-document
and has a.pdf
extension). - If the file is not found among the attachments of the current page, it will show as "my-document.pdf (file not found)".
- This will create a link displaying "my-document.pdf" that links to the attached file named
File Link with Custom Text:
{{{{ Download Our Report | annual_report.pdf }}}}
- This will display "Download Our Report" as the link text, pointing to the attached file
annual_report.pdf
.
- This will display "Download Our Report" as the link text, pointing to the attached file
Linking by Slug (if no extension in tag):
{{{{ important-data }}}}
- This will attempt to find an attached file on this page with
filename_slug
equal toimportant-data
, regardless of its extension. If multiple files have this slug (e.g.important-data.csv
andimportant-data.txt
), the first one found will be linked. It's usually better to include the extension for clarity:{{{{ important-data.csv }}}}
.
- This will attempt to find an attached file on this page with
Example (after attaching a file named
example-image.png
to this 'Home' page):Check out this image: {{{{ My Cool Screenshot | example-image.png }}}}
Or just the file: {{{{ example-image.png }}}}
(Note: For this demo to work, you'd need to edit this 'Home' page, upload a file named 'example-image.png' with
filename_slug
as 'example-image', save, and then this link would become active.)
Managing Your Wiki
- All Pages: Use the "All Pages" link in the side menu to see a list of all pages in the wiki.
- Create New Page: If you are logged in, use the "Create New Page" link in the side menu. You can also create pages by following a " (create)" link generated by a
[[NonExistentPage]]
WikiLink. - Edit Page: When viewing a page, logged-in users will see an "Edit This Page" button.
- Search: Use the search bar in the side menu to find pages by title or content.
- Menu Configuration: The side menu itself is configured by a special wiki page. You can edit it by navigating to the
[[{MENU_CONFIG_PAGE_SLUG.replace('-', ' ').title()}]]
page (link usually found under "Configuration" in the menu).
Happy Wiki-ing!