2003-02-16

POD Text Formatter Plugin 0.1 for Movable Type Released

NOTE: Since Gregor's World is no longer implemented with Movable Type, this article has been edited to show first what the rendered output used to look like, then what the input that generated it looked like.

I have released a POD Text Formatter plugin for Movable Type 2.6 (http://www.movabletype.org/news/2003_02.shtml#000782).

I'll write more about it later, but my browser just died and took the draft with it, and I don't feel like going back into that much detail again.

You can find the formatter at http://www.focusresearch.com/gregor/sw/pod/.

There are a few things to note:

  • Remember to start your entry with =something, =pod if you've got nothing better to use.
  • The L link stuff doesn't work right, and blame for now lies partially with the POD to SAX events stuff (sometimes you would expect it to convert to an <xlink> element, but it converts to <link>), and partially with the XML::XSLT stuff (it appears to fire the <link> template sometimes for <xlink> elements). If it turns out I'm to blame, though, I'll be happy. Presumably that would mean the fix would be eaiser.
  • The handling of S sucks, aparently due to to POD::SAX.
  • Beware of numeric E stuff. I saw some weird results.
  • X is being eaten for now

Anyway, if you do give it a try, let me know what you think. Below is a sample of some formatting:

- - - - - - - - - - - - - - - - - - -

This is an ordinary paragraph.

THIS IS A HEAD1

This is a Head2

this is a head3

this is a head4

#!/usr/bin/perl -w
use strict;
use warnings;
# Hey! Ain't this a great verbatim paragraph?
# Check out this <?xml looking='stuff'?> and <this>stuff, too!</this>

Here are some tags:

  • bold
  • code
  • Code with an embedded < and >
  • file/name.txt
  • italic
  • Manpage link: LINK[ page = 'ls', type = 'pod', section='' ]
  • Manpage section link: LINK[ page = 'ls', type = 'pod', section='foo' ]
  • This page section link: LINK[ page = '', type = 'pod', section='This is a head3' ]
  • Specific-text link: LINK[ page = 'no-blah', type = 'pod', section='' ]
  • URL link: LINK[ page = '', type = '', section='' ]
  • CPAN ( LINK[ page = '', type = '', section='' ] )
  • URL link w/name: LINK[ page = '', type = 'pod', section='Gregor's World' ]
  • index entry:
  • zero-width character: ''

Here are some entities:

  • lt: <
  • gt: >
  • verbar: |
  • sol: /

Here's a '*' list:

  • foo
  • bar

Here's a numbered list:

  1. Some stuff

  2. Some other stuff

  3. There is no "3" stuff.

  4. That's the end of the stuff.

Here's a term list:

  • foo

    This is the foo entry

  • bar

    This is the bar entry


=pod

I have released a POD Text Formatter plugin for Movable Type 2.6
(http://www.movabletype.org/news/2003_02.shtml#000782).

I'll write more about it later, but my browser just died and took the draft
with it, and I don't feel like going back into that much detail again.

You can find the formatter at http://www.gregorpurdy.com/gregor/sw/pod/.

There are a few things to note:

=over 4

=item Remember to start your entry with C<=something>, C<=pod> if you've
got nothing better to use.

=item The C<L> link stuff doesn't work right, and blame for now
lies partially with the POD to SAX events stuff (sometimes you would
expect it to convert to an C<< <xlink> >> element,
but it converts to C<< <link> >>), and partially with
the XML::XSLT stuff (it appears to fire the C<< <link>
>> template sometimes for C<< <xlink> >> elements).
If it turns out I'm to blame, though, I'll be happy. Presumably that would
mean the fix would be eaiser.

=item The handling of C<S> sucks, aparently due to to POD::SAX.

=item Beware of numeric C<E> stuff. I saw some weird results.

=item C<X> is being eaten for now

=back

Anyway, if you do give it a try, let me know what you think. Below is a
sample of some formatting:

 - - - - - - - - - - - - - - - - - - -

=pod

This is an ordinary paragraph.

=head1 THIS IS A HEAD1

=head2 This is a Head2

=head3 this is a head3

=head4 this is a head4

  #!/usr/bin/perl -w
  use strict;
  use warnings;
  # Hey! Ain't this a great verbatim paragraph?
  # Check out this <?xml looking='stuff'?> and <this>stuff, too!</this>

Here are some tags:

=over 4

=item B<bold>

=item C<code>

=item C<< Code with an embedded < and > >>

=item F<file/name.txt>

=item I<italic>

=item Manpage link: L<ls>

=item Manpage section link: L<ls/"foo">

=item This page section link: L</"This is a head3">

=item Specific-text link: L<blah-blah|no-blah>

=item URL link: L<http://www.gregorpurdy.com/>

=item CPAN (L<http://www.cpan.org/>)

=item URL link w/name: L<http://www.gregorpurdy.com/|Gregor's Web Page>

=cut

  =item S<no break on whitespace span>

=item index entry: X<entry,index>

=item zero-width character: 'Z<>'

=back

Here are some entities:

=over 4

=item lt: E<lt>

=item gt: E<gt>

=item verbar: E<verbar>

=item sol: E<sol>

=cut

  =item 0x2222: E<0x2222>

  =item 075: E<075>

  =item 181: E<181>

=back

Here's a '*' list:

=over 4

=item * foo

=item * bar

=back

Here's a numbered list:

=over 4

=item 1.

Some stuff

=item 2.

Some other stuff

=item 3.

There is no "3" stuff.

=item 4.

That's the end of the stuff.

=back

Here's a term list:

=over 4

=item foo

This is the foo entry

=item bar

This is the bar entry

=back

No comments: