- Joined
- Jul 31, 2017
- Messages
- 500
Well hello to everyone!
I "allowed" myself to fiddle around with the Cerberus X documentation a bit. So far, I almost exclusively molested the language reference:
I also touched the Home page, where I added a link to the Key codes reference.
And I improved the Resource paths reference by introducing the section about what the app's data directory actually is (so far, this is only mentioned in the Trans reference).
I upload them here, so you can already have a look. Extract the files to
Cerberus/docs/cerberusdoc/Home.cerberusdoc
Cerberus/docs/cerberusdoc/Programming/Resource paths.cerberusdoc
Cerberus/docs/cerberusdoc/Programming/Language reference.cerberusdoc
and rebuild the help to see what I've done. You can back-up these files before you overwrite them if you wan't.
I will look at the other chapters too. My goal is to put an updated documentation to the git repository once we're happy with the result.
I "allowed" myself to fiddle around with the Cerberus X documentation a bit. So far, I almost exclusively molested the language reference:
- Added all hierarchy levels to the contents (for quick access)
- Since the Contents are now longishly, they automatically split up into convenient columns)
- Added headings for many categories (e.g. Literals of every Type, String and Array Methods, Property Methods etc)
- Split the chapter Programs and declarations into two
- Updated the Strict mode chapter as it falsely stated that in strict mode, all function calls need brackets, which is not entirely true (i.e. Print "I don't cause trouble" works fine)
- Added chapter Literals
- Added a table of data types to the Types chapter also including the short notation for types
- Rearranged the type sub-chapters so they all follow the rule "type description", "special functionality", "type literals"
- Added chapter Character literals
- Made it absolutely clear that the table with the operators is actually in order (precedence)
- Turned the list of assignments into a more convenient table
- Added chapter Asset import (I think it's at the right place, since this language feature overloads the functionality of the Import keyword)
- Added chapter Custom preprocessor directives
- Added chapter Optimisation (I strongly believe this is a language feature and therefore should be placed in the language reference)
- Added chapter I've seen... for strange syntax sightings (I mean, what do you search for in the docs when you see <T> in a code and have absolutely no idea what this is?)
- Added Glossary (alphabetical index of all cue words I could think of or imagine someone else trying to learn Cerberus X could think of)
- Turned a lot of "please see chapter XYZ" into ACTUAL CLICKABLE LINKS
- Harmonised a lot of phrasings and/or formatting
I also touched the Home page, where I added a link to the Key codes reference.
And I improved the Resource paths reference by introducing the section about what the app's data directory actually is (so far, this is only mentioned in the Trans reference).
I upload them here, so you can already have a look. Extract the files to
Cerberus/docs/cerberusdoc/Home.cerberusdoc
Cerberus/docs/cerberusdoc/Programming/Resource paths.cerberusdoc
Cerberus/docs/cerberusdoc/Programming/Language reference.cerberusdoc
and rebuild the help to see what I've done. You can back-up these files before you overwrite them if you wan't.
I will look at the other chapters too. My goal is to put an updated documentation to the git repository once we're happy with the result.