You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flex.apache.org by Michael Schmalle <te...@gmail.com> on 2015/06/11 23:49:34 UTC

[ASDoc] ASDoc client based of velocity templates

Hi,

I have code I wrote about 3 years ago just sitting, it is a full working
ASDoc client that uses Apache Velocity templates instead of XSL to render
the HTML.

I created this back when I sold UI components as an internal tool for
documenting my won work for product documentation.

As it stands it uses an accessor/analyzer/converter/renderer template to
create the docs.

It's setup using a Flex project and I had it documenting skinparts and
states as well. I can't remember but I did have a version that did MXML as
well.

I am just curious if anybody is interested in me committing this, or should
the other ASDoc tool just be used instead. I already have a lot of work
with real life and the cross compiler project. Maybe somebody that knows
some Java is interested in tinkering with it?

Theoretically, since it uses a convertor, you could implement an XSL/PDF
type generation as well. The Accessor class gives a full map of hierarchies
and other various things for code tools as well.

Mike

AW: [ASDoc] ASDoc client based of velocity templates

Posted by Christofer Dutz <ch...@c-ware.de>.
Would love to have this :-)

I remember having some really big trouble in the Flexmojos Testsuite with some quirks in ASDoc starting with Adobe Flex 4.6 ... Velocity is also really cool. I use it in a lot of projects and it should produce more solid output than the XSLT approach. And finally it's Apache ... so it's even cooler ;-)

Chris

________________________________________
Von: Michael Schmalle <te...@gmail.com>
Gesendet: Freitag, 12. Juni 2015 01:06
An: dev@flex.apache.org
Betreff: Re: [ASDoc] ASDoc client based of velocity templates

Well the output format is created from a tree of objects(traversing). :)

What I mean is, the convertor traverses the object model based on page
structure so it doesn't do what you are asking right now. But sure, XML
could be emitted then say Velocity could be written, but that is two passes
and the reason I wrote it was for one pass and it's really fast. But that
was for my work years ago because I hated asdoc and how slow and particular
it was.

I will just not worry about it right now.

I still don't quite get what you are aiming at for an AIR app, to much
going on in my head. :)

Mike


On Thu, Jun 11, 2015 at 6:58 PM, Alex Harui <ah...@adobe.com> wrote:

> I don’t know all of the pieces that go into ASDoc.  Is there some output
> format like XML that then goes into Velocity or are you sticking in some
> non-standard format?  Having some canonical data format would be good so
> that folks can write other transformations but not necessarily know
> Velocity or XSL.  For example, I still have dreams of writing an AIR app
> to view the docs for FlexJS so we can do more fancy filtering.
>
> -Alex
>
> On 6/11/15, 2:49 PM, "Michael Schmalle" <te...@gmail.com> wrote:
>
> >Hi,
> >
> >I have code I wrote about 3 years ago just sitting, it is a full working
> >ASDoc client that uses Apache Velocity templates instead of XSL to render
> >the HTML.
> >
> >I created this back when I sold UI components as an internal tool for
> >documenting my won work for product documentation.
> >
> >As it stands it uses an accessor/analyzer/converter/renderer template to
> >create the docs.
> >
> >It's setup using a Flex project and I had it documenting skinparts and
> >states as well. I can't remember but I did have a version that did MXML as
> >well.
> >
> >I am just curious if anybody is interested in me committing this, or
> >should
> >the other ASDoc tool just be used instead. I already have a lot of work
> >with real life and the cross compiler project. Maybe somebody that knows
> >some Java is interested in tinkering with it?
> >
> >Theoretically, since it uses a convertor, you could implement an XSL/PDF
> >type generation as well. The Accessor class gives a full map of
> >hierarchies
> >and other various things for code tools as well.
> >
> >Mike
>
>

Re: [ASDoc] ASDoc client based of velocity templates

Posted by Michael Schmalle <te...@gmail.com>.
Well the output format is created from a tree of objects(traversing). :)

What I mean is, the convertor traverses the object model based on page
structure so it doesn't do what you are asking right now. But sure, XML
could be emitted then say Velocity could be written, but that is two passes
and the reason I wrote it was for one pass and it's really fast. But that
was for my work years ago because I hated asdoc and how slow and particular
it was.

I will just not worry about it right now.

I still don't quite get what you are aiming at for an AIR app, to much
going on in my head. :)

Mike


On Thu, Jun 11, 2015 at 6:58 PM, Alex Harui <ah...@adobe.com> wrote:

> I don’t know all of the pieces that go into ASDoc.  Is there some output
> format like XML that then goes into Velocity or are you sticking in some
> non-standard format?  Having some canonical data format would be good so
> that folks can write other transformations but not necessarily know
> Velocity or XSL.  For example, I still have dreams of writing an AIR app
> to view the docs for FlexJS so we can do more fancy filtering.
>
> -Alex
>
> On 6/11/15, 2:49 PM, "Michael Schmalle" <te...@gmail.com> wrote:
>
> >Hi,
> >
> >I have code I wrote about 3 years ago just sitting, it is a full working
> >ASDoc client that uses Apache Velocity templates instead of XSL to render
> >the HTML.
> >
> >I created this back when I sold UI components as an internal tool for
> >documenting my won work for product documentation.
> >
> >As it stands it uses an accessor/analyzer/converter/renderer template to
> >create the docs.
> >
> >It's setup using a Flex project and I had it documenting skinparts and
> >states as well. I can't remember but I did have a version that did MXML as
> >well.
> >
> >I am just curious if anybody is interested in me committing this, or
> >should
> >the other ASDoc tool just be used instead. I already have a lot of work
> >with real life and the cross compiler project. Maybe somebody that knows
> >some Java is interested in tinkering with it?
> >
> >Theoretically, since it uses a convertor, you could implement an XSL/PDF
> >type generation as well. The Accessor class gives a full map of
> >hierarchies
> >and other various things for code tools as well.
> >
> >Mike
>
>

Re: [ASDoc] ASDoc client based of velocity templates

Posted by Alex Harui <ah...@adobe.com>.
I don’t know all of the pieces that go into ASDoc.  Is there some output
format like XML that then goes into Velocity or are you sticking in some
non-standard format?  Having some canonical data format would be good so
that folks can write other transformations but not necessarily know
Velocity or XSL.  For example, I still have dreams of writing an AIR app
to view the docs for FlexJS so we can do more fancy filtering.

-Alex

On 6/11/15, 2:49 PM, "Michael Schmalle" <te...@gmail.com> wrote:

>Hi,
>
>I have code I wrote about 3 years ago just sitting, it is a full working
>ASDoc client that uses Apache Velocity templates instead of XSL to render
>the HTML.
>
>I created this back when I sold UI components as an internal tool for
>documenting my won work for product documentation.
>
>As it stands it uses an accessor/analyzer/converter/renderer template to
>create the docs.
>
>It's setup using a Flex project and I had it documenting skinparts and
>states as well. I can't remember but I did have a version that did MXML as
>well.
>
>I am just curious if anybody is interested in me committing this, or
>should
>the other ASDoc tool just be used instead. I already have a lot of work
>with real life and the cross compiler project. Maybe somebody that knows
>some Java is interested in tinkering with it?
>
>Theoretically, since it uses a convertor, you could implement an XSL/PDF
>type generation as well. The Accessor class gives a full map of
>hierarchies
>and other various things for code tools as well.
>
>Mike