On 7/10/07, João Abecasis <[EMAIL PROTECTED]> wrote:
> Hi!
>
> I've been watching you guys have all the fun that I thought I'd throw in
> a couple more cents... :-)
:D
> Matias Capeletto wrote:
> > Maybe a new page will be better to avoid confusing people not related with
> > IBD.
>
> I think you should have two pages, given your objectives.
Lets see...
> A demonstration sample, is supposed to be a visible face for your
> "users" (doc writers?). This should be clean and to the point. A doc
> writer should look at it and think "I want my docs to look like that!"
> Some notes on usage and best practices might also be good.
Ok, that is the actual DocTest + some notes.
> Well, I guess, the very own docs for Boost Docs and related tools should
> already be a showcase for this...
We will do exactly this. But the DocTest is a good one-stop shop for
showcasing the new style. We will populate our online docs with the
translated docs with time.
> Another page (or set of pages) would be your test cases. These most
> likely would contain isolated content samples, perhaps with some text
> pointing out what one is supposed to look at in the test. Taking this a
> bit further, the pages could work as an online poll. Each particular
> element to be tested would have an option where testers/viewers would
> register their answers. E.g.,
>
> #include <iostream>
>
> // For readability
> using namespace std;
>
> int main()
> {
> cout << "Hello World!\n";
> }
>
> The above code sample was generated from the quickbook
> source at _link_. For this test, please verify the following
> traits:
>
> The code block
> [ ] appears in a box,
> [ ] is syntax highlighted
> [ ] and in a monospaced font.
>
> [ ] Hovering the mouse on the upper-right corner of the
> block you can select the highlighting scheme.
> [ ] Moving the mouse away from that corner makes those
> options go away.
>
> ...
>
> [ Submit ]
>
> Ideally, you'd be able to gather test results, together with the
> browser's User-Agent string, some form of tester id and process those
> automatically...
>
> Anyway, it's an idea.
A very neat one indeed.
The only problem is that I will not have the time to pursue this
myself right now because I have others priorities for IBD. Do you want
to talk with Stuart to find people to do this? Or maybe you want to
help us.
Please do not let us monopolize the fun. ;)
Thanks for jumping in
Matias
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
