20,292
edits
OniGalore:Current events: Difference between revisions
restored my vision for better BSL documentation, even though we can't do it without installing an extension
m (added note to PS2 documentation project) |
(restored my vision for better BSL documentation, even though we can't do it without installing an extension) |
||
| Line 22: | Line 22: | ||
==BSL documentation== | ==BSL documentation== | ||
The revamp of the BSL docs | The goal is to replace the [[BSL:Functions]] and [[BSL:Variables]] pages with a more organized, sortable and readable system: | ||
# A single, master list of all functions and variables at [[BSL:List of built-in commands]] ("BSL:List" is a shortcut that redirects there). No longer will we have to browse two pages at once when we're trying to find a command but don't remember if it's a variable or function. The list is sortable by name, group, kind (function or variable), and platform availability, but does not contain any other info on the commands. It's just intended as a quick reference. You can click the group name for any command to go to the grouped page that discusses it in the context of related commands. | |||
# Grouped pages which discuss all the functions/variables related to a certain task. This is where the detailed coverage of commands will be found. See [[BSL:AI activity]] for an example. | |||
# Each command will also have its own page, so typing in the name of that command, e.g. "ai2_active", in the Go/Search box will take you to a page that allows you to either edit the basic information about that command or to visit its group's page. | |||
This revamp of the BSL docs was starting to be built on a system that I (Iritscen) hacked into the wiki, but it's too rickety and clumsy. The proper approach to interlinked documentation that reads from the same central pool of data would be the [[mw:Extension:Cargo|Cargo]] extension, if we can get it installed here. | |||
==Oni 2 and beyond...== | ==Oni 2 and beyond...== | ||