Much of the tutorial still needs to be written (TASK LIST)
Opened this issue · 14 comments
A good chunk of the tutorial is blank and simply directs readers to the (much more dense) language reference. These pages should be written up. This involves writing some clear, demonstrative example programs. Also, in how much detail we cover each topic before deferring to the reference will likely vary.
This thread is a task list for tutorial pages. It is locked (not accepting comments); if you want to contribute, please open a new issue. Thanks!
1-1: User Interaction
Needs expanding to include notification, ask and choose from.
1-2: Basic Syntax
Not written. Should briefly cover comments and value literals (numbers, strings, true/false, null), then discuss the theoretical and syntactic model of commands, and, by extension, operators.
1-3: Data Flow
Pretty good already, but should be reviewed and revised after the other pages are written.
2-1: Terms
Not written.
2-2: Dictionaries
Not written.
3-1: Specifiers
Not written.
3-2: Resources
Not written.
4-1: Interfacing with AppleScript
Not written.
4-2: Shells and Interpreters
Not written.
5-1: Functions
Not written, but includes an example of returnfrom a while ago.
5-2: Control Flow
Not written, but includes an incomplete description of the default command target from a while ago.
A: Built-in Terms
Currently copies the language reference. Should discuss what built-in terms are available and how they roughly work.
B: The BushelScript Project
Not written in either the tutorial or reference. Should describe the BushelScript project as a whole, and how to get involved.
(Staged Appendix) Built-in AppleScript Libraries
Would describe what the built-in AppleScript libraries are, how to import and use them (deferring to 4-1 for a generalized, in-depth explanation) and how to find the documentation for these libraries.