So when I started this forum few years ago, the idea was about having a good forum where people can talk about ActionScript 3.0 and related subjects
something not just there while there is hype and gone the next day when it’s not anymore “a la mode”
something that stay around and is of somewhat good quality, by that understand where people can actually write sample of source code with syntax coloring, where it is easy to copy/paste, where you can search, where there is no advertising or spam, etc.
Originally I wanted mainly a place where people can talk about redtamarin stuff but rethinking about it I just thought “what the hell let’s just include everything AS3”, hence here as3lang community forums.
But other things happened right and left.
First, as a developer I think having access to a language specification is quite important,
ok maybe not something you will refer to every day, but still something you do want to be able to consult from time to time, and there when you search “actionscript language specification” you should end up on this page
but instead you get a 404
that’s why few years ago I started to copy it to at the very worst have an archive of that spec
oh sure you have the web archives
but if you click on the latest archive from August 7th 2017, the way the HTML is done you can only see the frontpage and not navigate the spec, that’s not good.
But ultimately some wiki pages on a github does not really do it for me.
So from that I went to “oh let’s just make a book”, and so from the same markdown content and using something like gitbook I started to copy and archives that kind of important documentation.
Second, again with Redtamarin, it is not only the language spec I needed, I also wanted to document the whole builtins of the language and cleanly indicate: here stuff for Flash, here for AIR and here for Redtamarin.
In short, redoing the AS3LCR (ActionScript 3.0 Language and Component Reference)
that you all know located here help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/
Also, in this AS3LCR, I noticed few things not being documented anymore or other things that are available but considered “undocumented”, etc. so anyway I wanted to be able to publish the same doc and extend it with more docs and cover everything, yep even the undocumented stuff.
One example to keep it short, the
It should be listed under the package
flash.utils package, but it is nowhere to be found
If you point to the direct URL you can still find it here
Proxy class (at the bottom of the page you can see the doc was last generated
Mon Nov 28 2011, 06:48 AM -08:00)
Also in that doc you can read
Note: Prior to Flash 11 and AIR 3.0, the Proxy class was a member of the
flash.utilspackage. It is now a top-level class.
oh then we should find it in top-level then right ?
it is not listed there
and you can not find it here either
I’m not sure for you but for me it is a huge problem, the
Proxy class is highly useful and I would like to have some doc if/when I want to use it.
Publishing my own AS3LCR via Redtamarin, allow me then to keep the documentation around.
Third, but there is more.
See, in this AS3LCR, you can find link that reference other documentations
- under Related API Elements
you will find internal link that redirect to another part of the AS3LCR
- under Learn more
you will find external links to either other Adobe documentations or any other websites
- under More examples
you will find external links to other Adobe documentations that are directly related to ActionScript
that other Adobe documentations that are directly related to ActionScript
it is the ActionScript 3.0 Developer’s Guide
And I thought, oh wait … if this doc goes down there is a monumental piece of ActionScript knowledge that will be gone for good, and again that is no good.
For example, even if I duplicate perfectly or even better the AS3LCR
if you consult the Array class documentation
under more examples: Creating arrays
point to the page
http://help.adobe.com/en_US/as3/dev/WS5b3ccc516d4fbf351e63e3d118a9b90204-7ee1.html (which is part of the “ActionScript 3.0 Developer’s Guide”)
Sure, for now I can use those links in my own documentation, but what if those other sites go down?
Ideally, ultimately, I would like to replace the link with a copy of this documentation to be very sure it never ever goes down.
That’s why I’m announcing the following projects which goal are purely based on preserving the documentation we have, and why not extend/improve it if the opportunity occurs.
From the Redtamarin project
- a complete copy of the AS3LCR (within the Redtamarin sources)
- and a reference manual that goes deeper on Redtamarin related subjects
Redtamarin Software Development Kit Reference
From the as3lang project
ActionScript 3 Language Specification
ActionScript 3 Ecosystem Starter Pack
ActionScript 3 Documenting Projects
ActionScript 3 Cross-Platform Applications Development
- more to come (eg. a book that replicate the structure/content of the “ActionScript 3.0 Developer’s Guide”)
all those books will be hosted and available online at something like
doc.as3lang.org or whatever
Those are empty repositories, I mainly written bit of this and there on local repos, I need to sync all that.
In principle, all books are structured based on gitbook (even if considered deprecated it is good enough for now), they will be mainly published in English, but other languages are possible and they are there to cover the basics of working with ActionScript 3.
Each books will be published as
- HTML, gitbook frames
- single page HTML
And will be available online and as downloadable archives if you need a local copy.
Here few screenshots on the as3spec
That said, I’m no book writer and I do know all these are time consuming projects, so I was wondering who in the community would be interested in contributing ?
anything really: writing, copy editing, designing, etc.
The idea is to have reference manuals so instead of repeating the same things over and over on forums we can simply point to some nice documentation eg. documenting what Adobe does not really document (and will probably not), also preserving/copying already existing documentations that might vanish in the future.
As “reward” so far I can only offer the classic github kudos and your twitter/name/company listed under the contributors list, maybe later some documentation bounty I could sponsor, but that’s about it I guess.
Nothing urgent off course, depending on the motivation around it I will sync sooner or later on github, eg. if nobody care I will sync probably later on my own time, if some interests I will sync earlier so people can access the sources etc.
let me know what you think