psx.wiki

Editing Help: Difference between revisions

Revision as of 00:14, 23 October 2026
RemmyLee
(CLAUDE.md: full path to slop.py)		Revision as of 00:29, 23 October 2026
RemmyLee
(Editors: invite-only accounts, edit on save through the page checks and slop gate)
Line 1:Line 1:
+---
+title: Editing Help
+type: portal
+---
+
+## Accounts
+
+Accounts are by invite only. An invite link is valid for 14 days.
+
+The owner and admins create invite links on the Users page.
+
+## Page Source
+
+A page is plain text in Markdown. The edit form shows the whole source of the page.
+
+The source opens with a header between two lines of three dashes:
+
+```
+---
+title: Graphics Processing Unit (GPU)
+type: component
+summary: Drawing processor and display controller of the PlayStation.
+category: Hardware
+info: Model number = SCPH-1001
+---
+```
+
+Table: Header keys
+
+| Key | Use |
+| --- | --- |
+| title | Page title. |
+| type | Page type. See the next table. |
+| summary | One line that states what the subject is. |
+| category | One category per line. A page can have more than one. |
+| info | One infobox row per line, written as Label = value. |
+
+The address of a page comes from its place in the source tree. The page hardware/gpu is at /hardware/gpu/.
+
+## Page Types
+
+The page types are:
+
+Table: Page types
+
+| Type | Required sections | Required info rows |
+| --- | --- | --- |
+| component | Overview, References | |
+| register | Summary, References | |
+| libref | Explanation, References | Library, Header File, Introduced |
+| game | Releases, References | Serial, Region, Developer, Publisher, Release date |
+| model | References | Model number, Region, Released |
+| tool | References | |
+| format | References | |
+| history | References | |
+
+Each page type has a fixed set of sections. A page that does not follow its type is not saved.
+
+Two types also fix the order of their sections:
+
+Table: Section order
+
+| Type | Sections in order |
+| --- | --- |
+| libref | Syntax, Structure, Explanation, Return value, See also, References |
+| game | Releases, Disc data, Save data, Video, Input, Audio, Development, Reception, Issues, Notes, References |
+
+References is the last section of every page.
+
+## Tables
+
+Write a line in the form "Table: label" directly above each table. The wiki numbers the tables on each page.
+
+A table without this line is not saved.
+
+## Citations
+
+Every fact needs a source. Cite it with a footnote:
+
+```
+The GPU has 1 MB of video memory (VRAM).[^hw33]
+
+## References
+
+[^hw33]: Sony Computer Entertainment Inc. PlayStation Hardware. August 1998. Page 3-3.
+```
+
+## Links
+
+Link to another page with its address: `[GPU](/hardware/gpu/)`.
+
+A link to a page that does not exist is not saved. Create the page first.
+
+## Writing Rules
+
+Pages are written in the voice of Sony's PlayStation developer manuals.
+
+Write one fact per sentence. Use the present tense.
+
+Keep each paragraph to one or two sentences.
+
+A heading is a noun label like "Frame Buffer". A heading has no comma and no question mark.
+
+Do not use em dashes or en dashes. Write a range as "0 to 1023".
+
+Do not use booster words such as "simply", "easily", "powerful" or "actually".
+
+## Saving
+
+Show preview runs every check and shows the page as it will look.
+
+Show changes compares your text with the current page.
+
+Publish changes saves the page when every check passes. The page is live at once.
+
+When a check fails, the page is not saved. The list above the form names each problem. Your text stays in the box.
+
+## History
+
+The history tab lists every saved version of a page. Each row links to that version and to its changes.
+
+To restore an old version, open it from the history, choose "Edit this revision" and publish it.