c8bfad161cb7c0b3a28039af6d2283a4aa7f24ba
[elpher.git] / ISSUES.org
1 #+TITLE: Development notes/ideas
2 #+TODO: OPEN | CLOSED INVALID
3
4 * Enhancements
5
6 ** OPEN Allow multiple elpher buffers [0%]
7
8    Shouldn't be too hard, just need elpher-current-node to be
9 buffer-local and allow various buffer-switching procedures to
10 do something sensible.
11
12 Here are the things that need to be implemented before
13 this can happen:
14 - [ ] shift history out of node tree and into separate stack
15 - [ ] make history stack variables buffer-local
16    
17 ** OPEN Remove "redraw" command
18 This is only necessary for returning from displaying the raw
19 server response.  If I can provide a better way of doing that
20 then we can get rid of redraw entirely.
21
22 ** OPEN Replace support for user-specified starting pages
23 This used to be available, but was removed during a refactor.
24
25 ** OPEN Allow for grouping of bookmarks
26 To support this I'd like to add a bookmark page specific
27 set of keybindings.  Currently all bindings available on
28 the bookmark page are available everywhere else.  But
29 expanding and collapsing bookmark groups sounds like it
30 might need more specific bindings.
31
32 ** OPEN Implement Gemini support [88%]
33    
34 Here is the checklist of features required before release:
35 - [X] basic genimi transactions
36 - [ ] gemini transactions requiring client certificates
37 - [X] gemini input handling
38 - [X] gemini map files (text/gemini)
39 - [X] Support for plain text responses (text/*)
40 - [X] Support for image responses (text/image)
41 - [X] Support for mime-specified character encodeing
42 - [X] Saving responses to disk
43 - [X] Viewing raw responses
44   
45 The last few will be made infinitely easier if we factor the
46 gopher "getter" code differently.
47
48 * Bugs
49
50 ** OPEN History loops <2019-11-08 Fri>
51
52 Occasionally elpher gets stuck in a "history loop" where a
53 node is its own grandparent.  Obviously this sucks, as history
54 is elpher's main mechanism for making gopherspace exploration
55 painless.
56
57 I suspect the problem is in either ~elpher-visit-node~ or
58 ~elpher-visit-parent~.
59
60 * Completed improvements
61   
62 ** CLOSED Turn on lexical scoping
63
64    A branch exists for this, but there are some compilation kinks
65 to iron out.
66
67   
68 ** CLOSED Implement support for telnet entries
69
70 Similar to http entries, telnet entries will be handled by code
71 external to elpher. However it seems I made http entry handling a
72 special case, and I don't want another!  So the only option is to
73 bring both http and telnet entries back into the fold by representing
74 them both as standard nodes and having the grunt work done by getter
75 functions.
76
77 ** CLOSED Allow users to access selected and current node details.
78    
79 ** CLOSED Implement bookmark system
80
81   Currently the bookmark page replaces the current page, and it
82   does so silently (i.e. it doesn't become part of the link hierarchy).
83   I think this is a mistake, as it results in confusing behaviour when
84   traversing the link hierarchy after visiting one of the bookmarked links.
85
86   Instead, I think I should
87   1. Make the bookmark page part of the hierarchy, and
88   2. Reinstate the visited node hash table to avoid excess link hierarchy pollution.
89
90   In order to accomplish 1. it will be necessary to make the bookmark page renderer
91   a proper getter function, and one that never caches the contents of the buffer.
92
93   Actually, I might have to think about that a bit more.  I don't know
94   how to answer the question of what the best thing to do with node
95   parent links when using a cached node in place of a new node.  (Maybe
96   I always update node.parent unless parent is already an ancestor of
97   node?)
98
99   
100 ** CLOSED Support character encoding diversity
101
102 ** CLOSED Make URLs the basic address type.
103 Currently I waste a lot of effort converting between
104 URL and non-URL representations.  This is unnecessary, and
105 actually makes lots of things uglier.
106
107 For example, the bookmarks file contains addresses in Elpher's
108 internal representation, whereas I expect users would prefer
109 it contain URLs.
110
111 So the idea would be for (elpher-node-address node) to be
112 a either a string or a symbol, with symbols used for "special"
113 pages (bookmarks, start page, etc).  The getter functions
114 `elpher-address-selector' etc will still do what they currently
115 do, but will process the URL to do it.
116
117 This also means that non-gopher URLs will be explicitly represented
118 as such: no more abusing the "h" type for these.
119
120 * Closed issues
121
122 ** CLOSED Org mode faces are not present in recent emacs versions
123 Even 26.1 doesn't seem to have these.  This means that, for many
124 users, elpher doesn't show any difference between any of the
125 item types.  Not a major problem at all, but the faces we inherit
126 from should definitely be ones which have been present for much
127 longer.  Perhaps the font lock mode faces are the way to go after
128 all.
129
130 Update: changed all default faces to inherit from font-lock and basic faces.
131
132 ** CLOSED URL-centric addressing breaks bookmark file compatibility
133    
134 Need a way to allow people to rescue their old bookmark files
135 following this update.