This is an old revision of the document!
LOKSharp Wiki Style Guide
Use this page when creating or updating hosted wiki pages.
Source Of Truth
Git repository documentation is authoritative. The hosted DokuWiki is the published documentation surface.
Page IDs And Namespaces
Use lowercase page IDs with underscores between words.
| Content Type | Namespace Pattern |
|---|---|
| Landing page | namespace:start |
| Wiki conventions | wiki:* |
| Templates | wiki:templates:* |
| Operations notes | wiki:operations:* |
| Reverse-engineering pages | reverse_engineering:* |
| Protocol pages | protocol:* |
| Server pages | server:* |
| Client pages | client:* |
| Tools and workflow pages | tools:* |
Heading Levels
Use one level-1 heading per page:
====== Page Title =========== Major Section ========= Subsection ====
Keep pages scannable. Prefer short sections and tables over long unbroken prose.
Callout Pattern
Use plain text callouts so pages work on a fresh DokuWiki installation without extra plugins.
- Evidence: cite the source for a factual claim.
- Warning: identify a safety or compatibility risk.
- Compatibility: describe original-client compatibility constraints.
- Verification Needed: mark content that is not yet backed by accepted evidence.
Citation Formats
Every factual behavior claim needs one inline citation.
| Evidence Type | Format |
|---|---|
| Ghidra | Ghidra: lokserver.exe 0x00412134 |
| Packet capture | PCAP: capture-name.pcapng frame 42 |
| Database query | DB: SELECT …; result … |
| Repository source | Repo: src/Path/File.cs:123 |
If evidence is not available, mark the claim with Verification Needed: and keep it out of authoritative behavior summaries.
Packet Field Tables
Use this table shape for packet fields:
| Offset | Size | Name | Type | Evidence | Notes |
|---|---|---|---|---|---|
| 0x00 | 1 | message_id | byte | Ghidra or PCAP reference | Compatibility note |
Evidence Matrices
Use this table shape for system or feature evidence:
| Claim | Evidence | Status | Notes |
|---|---|---|---|
| Behavior summary | Repo, Ghidra, PCAP, or DB citation | Verified or Verification Needed | Compatibility notes |
Link Rules
Use DokuWiki links for wiki pages:
Use repository file references as text citations until a stable public repository URL is chosen.