Re: HotDrink examples

[John Freeman]

On 3/9/2012 3:19 PM, Gabriel Foust wrote:
> I know John wants us to be using the Google Code discussion boards, but
> I didn't see any way to attach a file to that. So I'm just sending an
> email for now.

Please check the latest email I sent on sharing work. Instructions here:

http://code.google.com/p/hotdrink/wiki/Sharing

Just send a URL for the repo, and a branch name or commit id.

> Does anyone have a working template for generating
> examples? Something from ORG mode?

There is no existing template.

> If not, I guess that's what I'll work
> on next.

Let's think of what we want from a template system. I'm thinking we may
want to use these examples both on the website and as standalone tests.
That suggests to me that we want to write the examples as sections to be
included in some other page. The website will import those sections in
one way, our test framework in another.

I'd rather not have to run a server to run our tests, so the tool that
compiles the test page would have to be something for which we can write
a Makefile, or that works in the browser to load sections through AJAX.

Thoughts?

- John

[Jaakko Järvi]

On Mar 9, 2012, at 3:51 PM, John Freeman wrote:

> On 3/9/2012 3:19 PM, Gabriel Foust wrote:
>> I know John wants us to be using the Google Code discussion boards, but
>> I didn't see any way to attach a file to that. So I'm just sending an
>> email for now.
>
> Please check the latest email I sent on sharing work. Instructions here:
>
> http://code.google.com/p/hotdrink/wiki/Sharing
>
> Just send a URL for the repo, and a branch name or commit id.
>
>> Does anyone have a working template for generating
>> examples? Something from ORG mode?
>
> There is no existing template.
>
>> If not, I guess that's what I'll work
>> on next.
>
> Let's think of what we want from a template system. I'm thinking we may want to use these examples both on the website and as standalone tests. That suggests to me that we want to write the examples as sections to be included in some other page. The website will import those sections in one way, our test framework in another.
>

I think org-mode should work well for that. The examples can be generated both to individual files and to
the main "tutorial" document. I will look into this how to set it up in org-mode.

> I'd rather not have to run a server to run our tests, so the tool that compiles the test page would have to be something for which we can write a Makefile, or that works in the browser to load sections through AJAX.
>

Agreed, better if server is not needed.

Jaakko

[John Freeman]

On 3/9/2012 3:19 PM, Gabriel Foust wrote:

> So just to get the ball rolling on examples, I'm including four samples.

I think the progression is good. I think I may want the tutorial text to
be separate from the examples it references, so that we can do nice
things like "run this example in another window" automatically, but we
can burn that bridge when we cross it.

- John