DocGen Preview 1
Thomas Tempelmann
Try it out, everyone.
Here are a few pointers:
- look into the templates folder. there you find .rhtml files. they
function like .php files: you write your html layout and embed some
rbscript code.
- the embedding works by either of these tags:
<? ... ?> --- for rb statements
<?= ... ?> --- for rb string expressions
- to see what functions you can call, look into the "includes" folder.
here's an example how i modified "class.rhtml" in order to make the
functions show not just their name but also their parms:
<? for each meth as RBMemberMethod in classItem.methods ?>
<li>
<?
if meth.returnType = "" then
print "sub " + meth.name + " (" + meth.parameterDeclaration + ")"
else
print "function " + meth.name + " (" + meth.parameterDeclaration +
") as " + meth.returnType
end
?>
</li>
<? next ?>
--
Thomas Tempelmann - exaggerating over a million times a day!
http://www.tempel.org/rb/ -- The primary source of outdated REALbasic
plugins and examples
Skype: tempel.org AIM: superTempel
Ed Kleban
As it turns out we just got a 3-day extension to get our slides in for
REALworld presentations. I've taken a couple screenshots to replace the
lack of any I had for DocGen. If someone will come up with a little fancier
template and some example source to run through it to show off what can be
done here I'd be most happy to update the example in the next couple days.
Might I suggest that using the mechanism to comment the application itself
would provide one possible good example. Or perhaps what we need is some
cannonical hello-world example that's commented with tags.
A few other quick questions:
1) The title this was published with was "DocGen" whereas the last time we
talked this was "RBDocGen". Is "DocGen" your final answer?
2) If you want to come up with an Icon for your program in the next day or
two I'll include it along with the others. (Same for you Thomas if you
want an icon to be shown for RBPT and/or RPBV).
3) Usage wise, I would love to have an option that generated output as a
single, long HTML file, with internal page references, that would make it
trivial to create say a .PDF from from a single long .HTML page to document
an application.
4) If thomas has an example of rhtml usage you can incorporate in your
examples I can simply copy and throw on a slide along with the generated
result, I'll gladly include that as well. I simply won't have time in the
next few days to mess with this myself.
Super good work SirG3. It's looking spiffy keen!
--Ed
SirG3
> REALworld presentations. I've taken a couple screenshots to replace the
> lack of any I had for DocGen. If someone will come up with a little fancier
> template and some example source to run through it to show off what can be
> done here I'd be most happy to update the example in the next couple days.
> Might I suggest that using the mechanism to comment the application itself
> would provide one possible good example. Or perhaps what we need is some
> cannonical hello-world example that's commented with tags.
Initially I was documenting DocGen with these tags, but I got lazy
about it after a while.
> 1) The title this was published with was "DocGen" whereas the last time we
> talked this was "RBDocGen". Is "DocGen" your final answer?
Hm, I'll go with RbDocGen as it's unique.
> 2) If you want to come up with an Icon for your program in the next day or
> two I'll include it along with the others. (Same for you Thomas if you
> want an icon to be shown for RBPT and/or RPBV).
I have no artistic ability, and no money to pay an artist, so it'll
have no icon till one is donated.
> 3) Usage wise, I would love to have an option that generated output as a
> single, long HTML file, with internal page references, that would make it
> trivial to create say a .PDF from from a single long .HTML page to document
> an application.
It's surely possible with the templates system (hell, you could create
the PDF with the templates =)).
Did you get my other email about this?
-- SirG3
Ed Kleban
When I opened a file named "RealOrder 01.02.rbp" the default project name
became "RealOrder 01.02."
I think it might be wise to remove the final "." so as to remove the
complete ".rbp" unless of course you're promting for a new extension, in
which case you may as well propose one, such as ".docgen" or ".html". I'm
not exactly sure what you envision here.
SirG3
apparently only tested it with a .rb file.
-- SirG3
Ed Kleban
On 1/30/06 5:24 PM, "SirG3" <thes...@gmail.com> wrote:
>> 1) The title this was published with was "DocGen" whereas the last time we
>> talked this was "RBDocGen". Is "DocGen" your final answer?
> Hm, I'll go with RbDocGen as it's unique.
That's your final answer? Congratualtions! You've won a trip for two on
the next manned exploration mission to Pluto.
Ed Kleban
>> 3) Usage wise, I would love to have an option that generated output as a
>> single, long HTML file, with internal page references, that would make it
>> trivial to create say a .PDF from from a single long .HTML page to document
>> an application.
>
> It's surely possible with the templates system (hell, you could create
> the PDF with the templates =)).
>
> Did you get my other email about this?
>
> -- SirG3
Other email? Not sure. I'm just waiting to have some more options under
the "Template: dummy" popup to play with.
SirG3
Templates are folders that have at least these two files:
main.rhtml
config.xml
The config.xml is used for holding settings for the template.
Currently the only possible settings is a list of options the template
has. This list of options is then used to generate a UI to set the
options at runtime (options.jpg), and the values for the options can
be accessed by the template when it runs. Templates can spawn other
templates (so you can output to more than one file), and can specify a
relative filename.
You can also swap out the default doc tag parser RBScript for your
own, allowing people to use their own documentation style.
The sample.rhtml file is a small example of syntax for template files.
RHTML stands for RBScript HTML
Hopefully that's enough info for your slides -- though, I think I can
get it done by the end of the month anyways =)."
Sent this a few days ago.
-- SirG3
Ed Kleban
On 1/30/06 6:05 PM, "SirG3" <thes...@gmail.com> wrote:
SirG3
main.rhtml. Also, the config.xml stuff didn't make it into preview 1,
still need to finish it up.
-- SirG3
Ed Kleban
I've got everything I need here to put together what I need for show and
tell. If we have a fancier example by the end of February I'll take that
along for show and tell also. I've got time scheduled for live demos after
the canned presentation. This is a great candidate.
Thanks!
--Ed
Scott Steinman
I haven't had time yet to play with DocGen (I'm up to my ears in
proofreading REAL World presentations, illustrating a book with my
wife, and starting the next phase of Reality Check), but what I've
seen so far looks great! Thanks!
Dr. Scott Steinman
Brought to you by a grant from the Steinman Foundation (Thanks, Mom
and Dad!)
Recommended by Major University Studies Over the Leading Brand
steinman at midsouth dot rr dot com
I hope I die peacefully in my sleep like my grandfather. . .not
screaming in terror like his passengers. -- "Deep Thoughts", Jack Handy
Asher Dunn
On Jan 30, 2006, at 6:24 PM, SirG3 wrote:
> It's surely possible with the templates system (hell, you could create
> the PDF with the templates =)).
Speaking from experience: that would *NOT* be fun ;-)
Asher
-------------------------
Asher Dunn
Head Developer, Fireye Software
http://www.fireyesoftware.com/
AIM, Yahoo, MSN: crazedglkid
Thomas Tempelmann
>
> 2) If you want to come up with an Icon for your program in the next day or
> two I'll include it along with the others. (Same for you Thomas if you
> want an icon to be shown for RBPT and/or RPBV).
No, sorry. Look at my website. Do you think I can design an icon? I
can't even come up with a good name!
Ed Kleban
On 1/31/06 2:37 AM, "Thomas Tempelmann" <tempe...@gmail.com> wrote:
>
> On 1/31/06, Ed Kleban <E...@kleban.com> wrote:
>>
>> 2) If you want to come up with an Icon for your program in the next day or
>> two I'll include it along with the others. (Same for you Thomas if you
>> want an icon to be shown for RBPT and/or RPBV).
>
> No, sorry. Look at my website. Do you think I can design an icon? I
> can't even come up with a good name!
>
Point taken.
Ok, if an when I dig out of getting ready for REAL World and have some free
time I'll give some though to making an Icon for RBPT and RbDocGen.
--Ed
Scott Steinman
After I'm done preparing for REAL World and a deadline at the same
time for illustrating a book (and getting over yet another migraine,
of course), maybe my wife and I can design an icon. She and I did
the artwork for Reality Check -- I did the initial design on paper
and she did the computer graphics.
-Scott
Ed Kleban
done for the REAL World session are the first time I've ever illustrated
anything -- and boy do they look like it, as Scott can attest.
If the Steinmans can make some icons for RB Project Tool and RbDocGen that
are even half as nifty as the Reality Check Icon, we'll have some great art
work to use.
Scott Steinman
I wouldn't use the Reality Check icon as an example of our best
work. We whipped up that one in a hurry. I was also worried about
using the actual REALbasic cube in my icon, so we created our own 3D
reflective cube. However, I don't think it looks that good. The
splash screen/about box screen is a better example of our art work.
Thomas, if you're coming to REAL World, I'll bring a T-shirt for you
to the meeting. I'll most likely be making all the T-shirts the same
size (XL) because most people wear their T-shirts a bit large and
they could possibly shrink in the wash a bit. I'm planning on using
the Reality Check splash screen on black fabric.
-Scott
Ed Kleban
On 1/31/06 2:37 AM, "Thomas Tempelmann" <tempe...@gmail.com> wrote: