Re: Project Start: Section 1

On Mon, Nov 11, 2002 at 10:34:00AM -0800, Michael Lazzaro wrote:
> ... I was thinking of something very basic -- just enough to get
> it into a database, for example.  You'd just copy a standard
> template and fill in the fields.  Like perhaps:
> 
> <section>
> <id> 1.1.2.1 </id>
> <title> Numeric Context </title>
> <text>
> Numeric Context is a <glossary>context</> full of cheesy goodness.  For 
> example, the following code will put <code>$obj</> in <code>int</> 
> context:
> <code>
>     my int $i = $obj;
>  </code>
> .... blah blah blah ...
> </text>
> <see>
>     <also> Context </also>
>     <also> Numeric Values </also>
> </see>
> <tests>
>     ...
> </tests>
> </section>
> 
> I agree it's more of a pain, but it's also conveying a *heck* of a lot 
> more information, for not really that much more to type.

I think POD is sufficiently extensible that we can add that
functionality without going 100% XML, e.g.:

=head1 NAME

1.1.2.1 - Numeric Context

=begin parrotdoc

<see><also>Context</><also>Numeric Values</></see>
<tests>...</tests>

=end parrotdoc

Numeric Context is a X<context> full of cheesy goodness.
For example, the following code will put C<$obj> in C<int> context:

 my int $i = $obj;

.... blah blah blah ...

=cut

So POD and XML are isomorphic with regards to information conveyable.
I think tools to convert POD <=> XML will be very easy to come by,
so perhaps we should come up with standard doc markup to facilitate
building those tools.

J