Userdocs for Christmas

0 views
Skip to first unread message

Hinrik Örn Sigurðsson

unread,
Mar 28, 2009, 1:31:19 PM3/28/09
to tpf-gsoc-students
I want to work on the user documentation tool proposed by Carl Mäsak
[1] for GSoC. I've written a draft application[2] for this, but
there's one thing this project depends on that I'm unsure of. It's the
fact that there's no Perl 6 parser/renderer/formatter for Perl 6 Pod.
Is that going to be a problem?

There's Perl6::Perldoc written in Perl 5, which works alright, and I
heard someone is working in a parser in Perl 6[3] but I don't know the
status of that project. I could make use of Perl6::Perldoc for now
since it's mostly complete, and make it easy to switch to a Perl 6-
based solution later.

Some comments on the application would be helpful as well.

1. http://svn.pugscode.org/pugs/docs/u4x/README
2. http://nix.is/gsoc/gsoc-u4x.txt
3. http://tinyurl.com/d75tdb

Gabor Szabo

unread,
Mar 28, 2009, 1:51:43 PM3/28/09
to tpf-gsoc...@googlegroups.com
2009/3/28 Hinrik Örn Sigurðsson <hinri...@gmail.com>:

Nice project.

Let me suggest you another goal:

Integration of psi with Padre, the Perl IDE.

IMHO many developers - especially those using Windows - will prefer
to have a GUI tool over a command line tool.
You can already write plugins to Padre in Perl 6 and run it in the same
process as Padre runs. So basically you can load the code of psi into Padre.
If its IO is not hard coded to STDIN/STDOUT then it will be quite easy to
connect it to Padre and thus provide a GUI for the Perl 6 documentation.

I'd be happy to help you with this.

regards
Gabor
http://padre.perlide.org/

Hinrik Örn Sigurðsson

unread,
Mar 28, 2009, 1:54:25 PM3/28/09
to tpf-gsoc-students
On Mar 28, 5:51 pm, Gabor Szabo <szab...@gmail.com> wrote:
> Let me suggest you another goal:
>
> Integration of psi with Padre, the Perl IDE.

I wouldn't mind including that. I've been following Padre's
development but I still haven't tried it out. Sounds like a worthwhile
goal.

mberends

unread,
Mar 28, 2009, 2:47:15 PM3/28/09
to tpf-gsoc-students
Regarding Pod::Parser, it currently renders plain text, manpages,
xhtml, pod5 and pod6 output for all the most common constructs in Perl
6 Pod, and also quite a lot of Perl 5 Pod. The suite is still
undergoing active development with updates every month. There is a
scalability problem apparently due to massive memory leaks in Rakudo
or Parrot, causing slow performance and limiting Pod file sizes to
under 100KB in a 2GB RAM system (yes, 100K fills 2G!). A re-
engineering effort is underway to circumvent the problem.

With some file size monitoring the Pod::Parser is already suitable for
previewing documents during authoring. A companion tool called
Pod::Server converts Pod to xhtml on the fly within a small Perl 6 web
server. More enhancements are expected during the coming weeks and
months.

Martin Berends

Gabor Szabo

unread,
Mar 28, 2009, 4:19:28 PM3/28/09
to tpf-gsoc...@googlegroups.com
2009/3/28 Hinrik Örn Sigurðsson <hinri...@gmail.com>:
>

So just to have a proof of concept of the integration,
I have uploaded Padre::Plugin::PSI to CPAN
that uses Perl 6 and Rakudo.

Gabor

ghengis_khan

unread,
Apr 1, 2009, 3:42:52 AM4/1/09
to tpf-gsoc-students
Slightly tangential to the application, but I'd really like to see a
POD to ODF converter.

On Mar 29, 4:31 am, Hinrik Örn Sigurðsson <hinrik....@gmail.com>
wrote:
Reply all
Reply to author
Forward
0 new messages