Special K - The Official Wiki

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

Code blocks

Emojis

See https://gist.github.com/rxaviers/7360908 for a useful list of emojis.

Links

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:

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

Steam URI

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>

Content tabs

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

Alternative keys (comma-delimited)

Examples

Mouse

Modifier keys

Special keys

With symbols/icons:

Numpad

Regular keys

Media keys

Controller buttons

Face buttons:

Left side:

Right side:

Directional 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.

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]