Editing Guide
For when you need an easy cheatsheet
This page is only visible in the sidebar menu for Editors and Administrators. Regular users and guests will not see the Editing section or direct link to this page.
Note that the page is still public, and therefor accessible to guests through the search/browse function.
The intent of this page is to provide easily accessible copy/paste cheatsheets and various other notes on editing. For now 'edit' the page to get the easily copied formatting.
Resources
- Wiki.js Markdown - Documentation of all supported Markdown formatting.
Code blocks
-
Inline
`Silent=true` -
Block
- The
phpstylesheet can be used to give the codeblock some partial sytanx highlighting.
```php [DrawState.Vertex] 67ce30e8=HUD c672a35c=HUD [DrawState.Pixel] 14d0a5bd=HUD ```- Becomes:
[DrawState.Vertex] 67ce30e8=HUD c672a35c=HUD [DrawState.Pixel] 14d0a5bd=HUD - The
Emojis
See https://gist.github.com/rxaviers/7360908 for a useful list of emojis.
Links
-
External link
[ReShade](https://reshade.me/) -
Internal link
[Check this page out!](/HDR/Calibration)- Note the starting
/. This tells Wiki.js that it's an absolute link. Not including that results in a relative link that might work at times (e.g. on the Home page) while not at other times (e.g. on a specific page where the language (en) gets added to the full URL).
- Note the starting
-
Internal direct section link
[Check this section out!](/HDR/Calibration#tips-and-tricks-sk-v-0111-edition)- Section title in lowercase with non-latin characters stripped out.
- For multiple sections with the same name on the same page, Wiki.js adds
-1to the second occurance (note: not the first/original section), and then on in that way. See the first vs. the second for an example. - Again, note the starting
/.
Custom URI schemes
A custom JavaScript function has been set up to convert some custom URI schemes into clickable links, though these comes with some downsides.
Supported URI schemes:
ms-settings:steam://
The use of :// in Steam links causes Wiki.JS to remove the link during the page save processing. This means that the actual href attribute (the link itself), is not retained at all. Instead the display text will be used to generate the link. This is not an issue with ms-settings: links as they normally exclude // by default anyway.
MS-Settings URI
-
Using a custom label for the link:
- Input:
[custom display text](ms-settings:display-advancedgraphics-default) - Generates: custom display text
- Input:
-
Pure link:
- Input:
[ms-settings:display-advancedgraphics-default](ms-settings:display-advancedgraphics-default) - Generates: ms-settings:display-advancedgraphics-default
- Input:
Steam URI
-
Using a custom label for the link: (note the lack of
//aftersteam:)- Input:
[custom display text](steam:open/main) - Generates: custom display text
- Input:
-
Pure link:
- Input:
[steam://open/main](steam://open/main) - Generates: steam://open/main
- Input:
Images
Right alignment
<figure class="image image-style-align-right">
<img src="Image here" width=470px;> <!-- width=470px is used on /SpecialK/Tools -->
<figcaption>Caption here</figcaption> <!-- optional -->
</figure>
content here (text)
<div style="clear:both";></div>
- Both classes
imageandimage-style-align-right(float:right) are provided by Wiki.js. - Floated elements aren't part of the flow of HTML elements, so we have to clear them.
Content tabs
-
Using headers and adding the {.tabset} class to the parent header. The parent header text will not be shown in the final result.
-
Note that you can use any header level, as long as the children headers are one level higher. For example, if a parent header is ### (h3), the tabs headers must be #### (h4). The maximum header level for a parent being 5 and the children 6.
Tabs
First Tab
Any content here will go into the first tab...
Second Tab
Any content here will go into the second tab...
Third Tab
Any content here will go into the third tab...
Formatting of keys
Basics
Keyboard shortcut
-
<kbd>Key 1</kbd> + <kbd>Key 2</kbd> + <kbd>Key 3</kbd>
Alternative keys (comma-delimited)
-
<kbd>Key 1</kbd>, <kbd>Key 2</kbd>,
Examples
- Ctrl + ⇧ Shift + ← Backspace
- ↑, ↓, ←, →
- Ctrl + ⇧ Shift + + / -
Mouse
- 🖱️ Click
- 🖱️ Right Click
Modifier keys
- Ctrl
- ⇧ Shift
- Alt
- AltGr
Special keys
With symbols/icons:
- ⇪ Caps Lock
- Tab ↹
- ⊞ Win
- Space ␣
- ↵ Enter
- ← Backspace
- ≣ Menu
Numpad
- Numpad 5
- Numpad /
- Numpad -
- etc
Regular keys
- A
- F1–F12
- ~
- .
- Home
- Print Scrn
- Scroll Lock
- etc
Media keys
- ⏵ Play
- ⏸ Pause
- ⏯ Play/Pause
- ⏴ Reverse
- ⏹ Stop
Controller buttons
Face buttons:
- A / ×
- B / ○
- X / □
- Y / △
Left side:
- LB / L1
- LT / L2
- LS / L3
Right side:
- RB / R1
- RT / R2
- RS / R3
Directional pad:
- ↑, ↓, ←, →
- D-pad
Mermaid diagrams
Currently Kroki is being used for server-side (offsite) rendering as wiki.special-k.info itself does not support server-side rendering.
This means that during editing, client-side rendering needs to be used to be able to preview the result. But before saving the page the diagram needs to be moved over to server-side rendering using Kroki.
The only difference is that kroki gets added on the first line after ```, with the diagram type being moved down a row.
-
Before (client-side rendering)
```mermaid graph LR ``` -
After (server-side rendering)
```kroki mermaid graph LR ```
Client-side rendering
The following section will not appear correctly on the page after editing, but will appear correctly in the preview pane during editing.
graph LR
user([User clicks on 'Start Injecting']) -->SKIM
SKIM --> cbt[Registers shell hook for 64-bit processes]
SKIM -- "calls" --> id2[rundll32.exe SpecialK32.dll,RunDLL_InjectionManager Install]
Server-side rendering
The following section will not appear correctly in the preview pane during editing, but will appear correctly on the page after saving it.
mermaid
graph LR
user([User clicks on 'Stop Injecting']) -->SKIM
SKIM --> cbt[Removes shell hook for 64-bit processes]
SKIM -- "calls" --> id2[rundll32.exe SpecialK32.dll,RunDLL_InjectionManager Uninstall]