README

   1 = olddoc - old-fashioned Ruby documentation generator
   2
   3 olddoc contains old-fashioned document generators for those who do not
   4 wish to impose bloated, new-fangled web cruft on their readers.
   5
   6 olddoc contains dark216, a HTML generator without any images, frames,
   7 or JavaScript.  It is designed for users of text-based browsers
   8 and/or low-bandwidth connections; yet respects user preference for
   9 light color schemes in new CSS browsers while favoring darkness for
  10 power savings on OLED and CRT displays.  dark216 focuses on text as
  11 it is the lowest common denominator for accessibility and compatibility
  12 with people and hardware.
  13
  14 == Reasons
  15
  16 * No CSS required.  Encouraging users to use CSS leads to problems like
  17   copy-paste hijacking: https://thejh.net/misc/website-terminal-copy-paste
  18   External CSS also increases page load time as it often blocks page
  19   rendering.  Asynchronous loading of CSS also causes accessibility
  20   problems as links/buttons may move as a user attempts to click.
  21
  22 * No JavaScript.  There is a constant barrage of security and
  23   client-side performance problems associated with it.  It's also
  24   unreasonable to expect users to rely on LibreJS and inspect every
  25   piece of JS they run.
  26
  27 * No frames.  Frames are an accessibility hassle and unfriendly
  28   to users of tiny screens on mobile devices and text-based browsers.
  29
  30 * No images.  Not everyone can view or afford bandwidth to load images.
  31   This also reduces the potential for security vulnerabilities as less
  32   code gets run.  Furthermore, loading the wrong image in a public
  33   place can get you arrested (or worse).
  34
  35 Encourage readers to simplify and speed up their browsing experience.
  36 They can disable CSS, JavaScript, and images in their browser without
  37 missing out!
  38
  39 == Usage
  40
  41         gem install olddoc
  42         cd $ANY_RDOC_USING_RUBY_PROJECT
  43         rdoc -f dark216
  44
  45 You can also use olddoc to generate NEWS entries
  46 assuming you have git tags, a README file and .olddoc.yml
  47
  48         olddoc prepare
  49
  50 And "olddoc merge" to merge instances of "olddoc_placeholder" in
  51 an HTML file with HTML fragments generated with other tools
  52 such as pandoc(1).  This requries an appropriately configured
  53 .olddoc.yml with a "merge_html" section see olddoc(5)
  54
  55 == Source code
  56
  57         git clone https://80x24.org/olddoc.git
  58
  59 Please use git-format-patch(1) and git-send-email(1) distributed with
  60 the git(7) suite for generating and sending patches.  Please format
  61 pull requests with the git-request-pull(1) script (also distributed
  62 with git(7)) and send them via email to <olddoc-public@80x24.org>
  63
  64 == Contact
  65
  66 All feedback (comments, results, feature requests, bug reports, patches,
  67 pull-requests) via plain-text email is very much appreciated.
  68
  69 Please send plain-text email to us at <olddoc-public@80x24.org>
  70 Use reply-to-all as we do not require any sort of subscription.
  71 HTML will not be read.  olddoc is for GUI-phobes, by GUI-phobes.
  72 We archive all of our mail publically at:
  73
  74         https://80x24.org/olddoc-public/
  75         nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
  76
  77 == License
  78
  79 olddoc is copyrighted Free Software by all contributors, see logs
  80 in revision control for names and email addresses of all of them.
  81
  82 olddoc is free software; you can redistribute it and/or modify it
  83 under the terms of the GNU General Public License as published by the
  84 Free Software Foundation; either version 3 of the License, or (at your
  85 option) any later version.
  86
  87 olddoc is distributed in the hope that it will be useful, but WITHOUT ANY
  88 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  89 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  90 for more details.
  91
  92 You should have received a copy of the GNU General Public License along
  93 with this program; if not, see https://www.gnu.org/licenses/gpl-3.0.txt