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