| 1 |
TODO -*- mode: org; coding: utf-8; -*- |
| 2 |
|
| 3 |
Scratch pad of bugs, missing features, and misbehaviors collected |
| 4 |
while using tkpod (best viewed with Emacs' org-mode). |
| 5 |
|
| 6 |
* BUGS |
| 7 |
** Tk::Pod |
| 8 |
*** Tk::Pod::Text should not manipulate the Toplevel's title [[cpanrt:67306]] |
| 9 |
Idea: one can mark the PodText as "-embedded". In this case no |
| 10 |
manipulations of the parent toplevel are done, especially the |
| 11 |
title is set untouched. Ideally this would be the other way, one |
| 12 |
should mark a "master toplevel" for the PodText, but well, because |
| 13 |
of backward compatibility the current behavior will stay. |
| 14 |
*** S<> seems often to be ignored |
| 15 |
May be a core Tk::Text bug (i.e. -wrap => "none" in tags being |
| 16 |
sometimes ignored) |
| 17 |
-> Should find sample Pod to easily reproduce this problem. |
| 18 |
*** For Windows: check whether Tk::More/Tk::Tree match the system background colors |
| 19 |
Also check if the "Help" menu item is on the correct place. |
| 20 |
*** Title is not displayed if function or FAQ pod in displayed in a new window |
| 21 |
or when navigating in the history back or forward to a function/FAQ pod |
| 22 |
*** $podtext->configure(-file => ...) does not work always as expected |
| 23 |
When set from a command line argument, then one expects to use the |
| 24 |
name of a module in perl's pod path (specified without .pm or .pod |
| 25 |
extension) or a (relative) path to a file (with extension). |
| 26 |
Example: |
| 27 |
|
| 28 |
cd ~/src/bbbike |
| 29 |
tkpod ESRI/esri2bbd.pl |
| 30 |
* now click on bbbike link => bbbike itself will be loaded, not bbbike.pod |
| 31 |
because of a -f test in findpod |
| 32 |
|
| 33 |
*** Do not move focus if already in PodText's search entry |
| 34 |
*** The perlfunc subentries do not show up in the history |
| 35 |
*** Links within perlfunc subentries do not work (seen in "-f import") |
| 36 |
*** Paragraphs after bullet and number items do not align correctly |
| 37 |
Tweaking the _indent functionality in Tk::Pod::SimpleBridge seems |
| 38 |
to be necessary. |
| 39 |
*** If .pod and .pm are located in separated directories, then the wrong file (the .pm) might be chosen |
| 40 |
Seen on Debian with IO::Handle. |
| 41 |
*** There is never a horizontal scrollbar, even if a verbatim block exceeds the window width |
| 42 |
An workaround would be to have the vertical scrollbar non-optional |
| 43 |
and the horizontal scrollbar optional (unfortunately both cannot |
| 44 |
be optional because of a bug in the Scrolled code). |
| 45 |
*** DONE old window is jumping after ctrl-n and ctrl-p |
| 46 |
because these already have bindings in Tk::Text |
| 47 |
-> workarounded, but need good checks first! |
| 48 |
** Tk::Pod::Search |
| 49 |
*** Reorder modules in the fulltext search results to reflect @INC order |
| 50 |
** Tk::More |
| 51 |
*** Highlight matches also in link text |
| 52 |
** tkpod |
| 53 |
*** In server mode, no commandline options are accepted |
| 54 |
Probably at least -h/-? should be supported and errors for other |
| 55 |
options dropped. |
| 56 |
*** Get rid of the numerous warnings in server/client mode. |
| 57 |
*** If the client sends a file which cannot be opened, then the server crashes! |
| 58 |
*** The tkpod client should send cwd, so relative filenames work in server mode, too. |
| 59 |
*** Some systems (e.g. Debian) may not have any perl documentation installed, i.e. no perl.pod |
| 60 |
tkpod should not die if perl.pod is not available, but maybe just |
| 61 |
start with a blank page. |
| 62 |
* WISHLIST |
| 63 |
** Tk::Pod |
| 64 |
*** History: prefer short pod names over filenames |
| 65 |
If filenames, then maybe show more than the basename, and maybe |
| 66 |
abbreviate it if it's too long. Do not record temporary file names |
| 67 |
(as in perldoc -f / -q) in history view. But show something |
| 68 |
sensible instead (currently it seems that there's only an empty |
| 69 |
entry). |
| 70 |
*** If "perlindex -index" is not run yet: ask user to run it? |
| 71 |
Problematic on Unix, because perlindex should be run as superuser. |
| 72 |
*** On Windows: show printer selection dialog first, maybe also on KDE/GNOME, if available |
| 73 |
*** Optionally save settings on exit, e.g. current base font size |
| 74 |
*** using other fonts |
| 75 |
Marek Rouchal writes: |
| 76 |
|
| 77 |
Subject: tkpod - other font |
| 78 |
|
| 79 |
Fine, there is a central |
| 80 |
place where I can do adaptations easily - but how can |
| 81 |
I easily override? The only solution I can imagine |
| 82 |
right now is to place a Tk::Pod::Styles in some |
| 83 |
$PERL5LIB directory and shadow the installation's |
| 84 |
Tk::Pod::Styles; there could be e.g. a |
| 85 |
-usestyle Tk::Pod::Styles::Mine |
| 86 |
option, where I can provide my own package, which inherits |
| 87 |
from Tk::Pod::Styles and overrides one or more subs. |
| 88 |
|
| 89 |
But I would appreciate a general solution with either a ~/.tkpodrc |
| 90 |
or the X resources, as already mentioned. |
| 91 |
|
| 92 |
-> There's now a solution with X resources, which are also |
| 93 |
settable with -xrm. But maybe a .tkpodrc solution would also be nice, |
| 94 |
especially for non-X11 people. |
| 95 |
*** Maybe patch Ulrichs TPJ example code for nroff pages to allow both POD and MAN in fulltext search dialog |
| 96 |
*** add meaningful regression tests |
| 97 |
*** use some kind of access control for the -s option |
| 98 |
*** new menu entry with a link list |
| 99 |
(e.g. all L<...> and everything looking like a module /\w+::\w+/) |
| 100 |
*** make ManViewer into a standalone widget, link entries in "SEE ALSO" |
| 101 |
*** option for interleaving POD and code |
| 102 |
*** show "No documentation found for "..."" if there's no pod in the file |
| 103 |
(just like perldoc) |
| 104 |
*** support for the new Pod::Index module |
| 105 |
(similar to the fulltext search) |
| 106 |
*** some kind of stylesheet support |
| 107 |
*** It should probably be possible to create the menus Section and History independently of the main Tk::Pod frame |
| 108 |
So the user may add these menus to the context menu of the PodText |
| 109 |
window. |
| 110 |
*** Maybe have a new popup menu entry View -> Pod info which shows path and basic Pod information |
| 111 |
*** If a Pod could not be found: add a button "Look at search.cpan.org" to the error dialog |
| 112 |
*** "Open Pod by name" dialog could be done nicer |
| 113 |
e.g. by using a rich Tk::Text instead of the label/message and use |
| 114 |
"sans serif"+"monospace" fonts. |
| 115 |
** Tk::More |
| 116 |
*** A menu item for switching between popular encodings |
| 117 |
Default probably to iso-8859-1 or maybe user's locale. |
| 118 |
*** A menu item (and maybe also the keyboard equivalent -x) for changing the indentation level |
| 119 |
*** If there are more configuration parameters resembling less, then maybe an environment variable like LESS could be useful for common configuration parameters |
| 120 |
Question: should this only be valid if it's called as tkmore or |
| 121 |
also if embedded in Tk::Pod? |
| 122 |
*** Tk/More status bar: filename % line x |
| 123 |
*** more 'more' like key bindings to Tk::More |
| 124 |
*** search should scroll per page |
| 125 |
*** search policies: regexp, glob, incremental (as in xmore) and 'normalized' as in perlindex |
| 126 |
Should go into it's own Tk::Text::Util.pm module |
| 127 |
|
| 128 |
Or: use Tk::FindBar (create it first by branching Tkx::FindBar) |
| 129 |
for incremental search. |
| 130 |
*** after switching between case sensitive/insensitive highlightning should be updated immediately |
| 131 |
*** automatic case-sensitive search |
| 132 |
if there is at least one uppercase character in the search string, |
| 133 |
then do a case-sensitive search (like emacs) |
| 134 |
*** 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) |
| 135 |
*** use Tk::HistEntry for search entry |
| 136 |
*** implement isearch |
| 137 |
*** <Return> over a link opens the link |
| 138 |
(but this needs some kind of "current link" feature, probably by |
| 139 |
using <Tab> or similar to select the next link). |
| 140 |
** Tk::Pod::Cache |
| 141 |
*** use a LRU cache with $MAX_CACHE documents |
| 142 |
*** maybe do not cache small documents at all |
| 143 |
*** store modtime of POD files and flush cache automatically if the file changed |
| 144 |
*** consider to cache per INC path, so user can use custom @INC/@PERLPOD and everything works as expected |
| 145 |
e.g. ~/tkpod_cache/perlspec(abspathofconfig)/MD5orSHA1ofpath |
| 146 |
~/tkpod_cache/perlspec(abspathofconfig)/.info |
| 147 |
** Tk::Pod::Tree |
| 148 |
*** Make tree busy while building first time |
| 149 |
*** Show a progress bar or an indicator when refreshing the pod index |
| 150 |
*** Build the tree in background, e.g. by using standard perl ipc (pipe+fork) |
| 151 |
This already happens for Unix, but it would be nice if it also |
| 152 |
implemented (and tested) on Windows systems. |
| 153 |
*** Show old cached contents while rebuilding the tree |
| 154 |
But show a notice that the tree is updated. Once the new tree is |
| 155 |
available, it should be displayed (and the currently opened leaves |
| 156 |
should be restored), and the update notice should be removed. |
| 157 |
*** Some zoom functionality |
| 158 |
Maybe depending on the zoom factor of the main window, and/or an |
| 159 |
additional menu entry. |
| 160 |
*** Should I include something similar to perlfunc for perlfaq (perldoc -q)? |
| 161 |
Maybe a new menu item "Search FAQ"? |
| 162 |
*** Implement C<-rememberopen> in C<Fill> method |
| 163 |
*** Mark modules which appear multiple times in the @INC tree |
| 164 |
e.g. with an exclamation mark, and maybe show the paths and |
| 165 |
versions(?) of both/all versions |
| 166 |
** tkpod |
| 167 |
*** Instead of listening to a tcp socket, maybe one should use a unix domain socket |
| 168 |
(security, a unix domain socket may be chown'ed and chmod'ed!) |
| 169 |
*** tkpod -s: should probably reuse the Pod window instead of re-creating new ones |
| 170 |
Maybe this should be controlled by another option. |
| 171 |
*** handle "-" for stdin |
| 172 |
* Expired problems |
| 173 |
These bugs are probably fixed or not reproducable or apparent on old |
| 174 |
systems only: |
| 175 |
** Ctrl-O Exporter does not work?! |
| 176 |
** What about the reported error on Suse Linux (see Tk-Pod entry on rt.cpan.org)? |
| 177 |
I can't reproduce this bug... |
| 178 |
** Dump does not always work on a RedHat 8.0 system, so I had to use a workaround. |
| 179 |
Also, Tk::Pod very often dumps core on this system in conjuction |
| 180 |
with perl5.8.0 and Tk800.025, but this might be a RedHat-related |
| 181 |
issue. |
| 182 |
* org-mode settings |
| 183 |
#+LINK: cpanrt http://rt.cpan.org/Public/Bug/Display.html?id=%s |
| 184 |
#+LINK: perlrt http://rt.perl.org/rt3/Ticket/Display.html?id=%s |