19,584
edits
OniGalore:Current events: Difference between revisions
→BSL tutorial(s): detailing my plan, in case there are any comments
(I said a little about this) |
(→BSL tutorial(s): detailing my plan, in case there are any comments) |
||
| Line 20: | Line 20: | ||
===BSL tutorial(s)=== | ===BSL tutorial(s)=== | ||
Despite its relative simplicity, [[BSL]] is vastly under-documented. Most of the stuff is well-known to experts, but designing a comprehensive guide that will get novice scripters started and keep them going requires didactic skills and ''lots'' of patience. Long-term goals are: a cross-referenced set of mini-tutorials that document the functions and variables in a standalone way (see, e.g., [[ai2_allpassive]]); maybe a functional breakdown of an original script (see [[BSL:Tutorial/airport1_level_logic.bsl|HERE]]); and redirects so that typing the name of the variable/function in the Go/Search box leads to just the right place. | Despite its relative simplicity, [[BSL]] is vastly under-documented. Most of the stuff is well-known to experts, but designing a comprehensive guide that will get novice scripters started and keep them going requires didactic skills and ''lots'' of patience. Long-term goals are: a cross-referenced set of mini-tutorials that document the functions and variables in a standalone way (see, e.g., [[ai2_allpassive]]); maybe a functional breakdown of an original script (see [[BSL:Tutorial/airport1_level_logic.bsl|HERE]]); and redirects so that typing the name of the variable/function in the Go/Search box leads to just the right place. | ||
:I am putting into effect soon a plan that will fulfill some of geyser's old goals for the BSL part of the wiki: | |||
:*I will be making the above-mentioned mini-tutorials for the BSL "commands" (variables + functions) that center around a certain topic. I have plans to make about 30 pages, which will be listed soon. However I currently have no plans to actually write the kind of thorough tutorials that geyser would have made; instead, I am just going to port all of the var/func info to the [[Template:BSLvar|var]] and [[Template:BSLfunc|func]] templates that I made (using templates means that we can easily tweak the display of all commands' information later, if anyone is not enamored with the [[User:Iritscen/TestSpace|current design]]). I will also bring over any small notes on the funcs/vars that I find laying around the wiki. But there won't be a comprehensive write-up on how exactly to use each one. The main goal is just to group all commands by subject matter, so I am calling these the "grouped" pages. | |||
:*Pages will be created for every function and variable. Viewing a page for a single command should give you the standard template display of the command's information, but there should also be a redirect link that goes to the grouped page, so you can view the command's documentation in context. | |||
:*A new page (originally to be called "BSL:Reference", but probably now going to be called something else; maybe "BSL:List of built-in commands"?) will list all functions and variables together. It will be sortable by name, group (subject matter), type (func or var), and platform availability (Win/Mac), but will not contain any other info on the commands. It's just intended as a quick reference. You will be able to click the name of any command to go to the grouped page that discusses it in the context of related commands. This table will hopefully be built automatically from the information entered elsewhere (sample [[User:Iritscen/TestSpace2|here]]). | |||
:*When this is done, BSL:Functions and BSL:Variables will be deleted or blanked. The instructions on those pages about how to use funcs/vars are now under [[BSL:Manual]], and the lists will not be useful once the "Reference" page is constructed. No longer will we have to browse two pages at once while trying to find a command we're thinking of but can't remember if it is a variable or function. | |||
:If anyone has any questions or concerns, either now or as I perform the work and things start to take shape, I guess we can just talk about it here (I will clear the talk when the project is done). If it's not clear what I am proposing, I will have a fuller "demo" available in the next few days that shows how the system is supposed to work. --[[User:Iritscen|Iritscen]] ([[User talk:Iritscen|talk]]) 23:06, 7 December 2015 (CET) | |||
==Oni 2 and beyond...== | ==Oni 2 and beyond...== | ||