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 ** IN-PROGRESS Implement Gemini support [62%]
  32
  33 Here is the checklist of features required before release:
  34 - [X] basic genimi transactions
  35 - [ ] gemini transactions requiring client certificates
  36 - [X] gemini input handling
  37 - [X] gemini map files (text/gemini)
  38 - [X] Support for plain text responses (text/*)
  39 - [X] Support for image responses (text/image)
  40 - [ ] Saving responses to disk
  41 - [ ] Viewing raw responses
  42
  43 The last few will be made infinitely easier if we factor the
  44 gopher "getter" code differently.
  45
  46 * Current issues
  47
  48 ** URL-centric addressing breaks bookmark file compatibility
  49
  50 Need a way to allow people to rescue their old bookmark files
  51 following this update.
  52
  53 * Completed improvements
  54
  55 ** DONE Implement support for telnet entries
  56
  57 Similar to http entries, telnet entries will be handled by code
  58 external to elpher. However it seems I made http entry handling a
  59 special case, and I don't want another!  So the only option is to
  60 bring both http and telnet entries back into the fold by representing
  61 them both as standard nodes and having the grunt work done by getter
  62 functions.
  63
  64 ** DONE Allow users to access selected and current node details.
  65
  66 ** DONE Implement bookmark system
  67
  68   Currently the bookmark page replaces the current page, and it
  69   does so silently (i.e. it doesn't become part of the link hierarchy).
  70   I think this is a mistake, as it results in confusing behaviour when
  71   traversing the link hierarchy after visiting one of the bookmarked links.
  72
  73   Instead, I think I should
  74   1. Make the bookmark page part of the hierarchy, and
  75   2. Reinstate the visited node hash table to avoid excess link hierarchy pollution.
  76
  77   In order to accomplish 1. it will be necessary to make the bookmark page renderer
  78   a proper getter function, and one that never caches the contents of the buffer.
  79
  80   Actually, I might have to think about that a bit more.  I don't know
  81   how to answer the question of what the best thing to do with node
  82   parent links when using a cached node in place of a new node.  (Maybe
  83   I always update node.parent unless parent is already an ancestor of
  84   node?)
  85
  86
  87 ** DONE Support character encoding diversity
  88
  89 ** DONE Make URLs the basic address type.
  90 Currently I waste a lot of effort converting between
  91 URL and non-URL representations.  This is unnecessary, and
  92 actually makes lots of things uglier.
  93
  94 For example, the bookmarks file contains addresses in Elpher's
  95 internal representation, whereas I expect users would prefer
  96 it contain URLs.
  97
  98 So the idea would be for (elpher-node-address node) to be
  99 a either a string or a symbol, with symbols used for "special"
 100 pages (bookmarks, start page, etc).  The getter functions
 101 `elpher-address-selector' etc will still do what they currently
 102 do, but will process the URL to do it.
 103
 104 This also means that non-gopher URLs will be explicitly represented
 105 as such: no more abusing the "h" type for these.
 106
 107 * Old issues
 108
 109 ** DONE Org mode faces are not present in recent emacs versions
 110 Even 26.1 doesn't seem to have these.  This means that, for many
 111 users, elpher doesn't show any difference between any of the
 112 item types.  Not a major problem at all, but the faces we inherit
 113 from should definitely be ones which have been present for much
 114 longer.  Perhaps the font lock mode faces are the way to go after
 115 all.
 116
 117 Update: changed all default faces to inherit from font-lock and basic faces.