TODO

Scratch pad of bugs, missing features, and misbehaviors collected during I used tkpod.

BUGS

Tk::Pod

  • What about the reported error on Suse Linux (see rt.cpan.org)? I can't reproduce this bug...

  • S<> seems often to be ignored. May be a core Tk::Text bug (i.e. -wrap => "none" in tags being sometimes ignored)

  • PodText: interrupt process() if another file is loaded... Sometimes strange things may happen like all text is underlined. => hopefully fixed now.

  • for Windows: check whether Tk::More/Tk::Tree match the system background colors

  • maybe special handling for Tk::Pod::FindPods under Mac OS X is necessary (pod directory is /System/Library/Perl/pods)

  • Correct title is not displayed if function pod in displayed in a new window or when navigating in the history back or forward to a function pod.

Tk::Pod::Cache

WISHLIST

Tk::Pod

  • cleanup search interface to perlindex. Maybe patch Ulrichs TPJ example code for nroff pages to allow both POD and MAN.

  • add meaningful regression tests

  • use some kind of access control for the -s option

  • new menu entry with a link list (e.g. all L<...> and everything looking like a module /\w+::\w+/)

  • maybe put the removed WWWBrowser code again to Tk::Pod::Text

  • option for interleaving POD and code

  • show "No documentation found for "..."" if there's no pod in the file (just like perldoc)

  • maybe you something selectable and copyable (e.g. Tk::ROText) in the About dialog

Tk::More

  • Tk/More status bar: filename % line x

  • more 'more' like key bindings to Tk::More.

  • More.pm: search should scroll per page

  • search policies: regexp, glob, incremental (as in xmore) and 'normalized' as in perlindex. Should go into it's own Tk::Text::Util.pm module

  • after switching between case sensitive/insensitive highlightning should be updated immediately

  • scrolling is not as exact as it shoule be (i.e. scroll forw, then scroll back will not get to the same position as before)

  • use Tk::HistEntry for search entry

  • implement isearch

Tk::Pod::Cache

  • use a LRU cache with $MAX_CACHE documents

  • maybe do not cache small documents at all

  • store modtime of POD files and flush cache automatically if the file changed

Tk::Pod::Tree

  • Idea: add another category "perl functions". Subitems are functions categories, the leafs are functions. Maybe use balloons to show short description of categories and functions. On click show the output generated by "perldoc -f". Implementation notes:

    use virtual name "perlfunc:
    use Pod::Functions for the category and function lists (it's part of the standard dist since when?)
    can I use the output of perldoc -f verbatim or should it be fed into a pod formatter?
  • Should I include something similar for perlfaq (perldoc -q)? Maybe a new menu item "Search FAQ"?

  • Implement -rememberopen in Fill method.