olddoc.git  about / heads / tags
olddoc - old-fashioned RDoc generator(s)
$ git log --pretty=format:'%h %s (%cs)%d'
d6fe198 olddoc 1.9.0 - imap_url support (2020-08-10)
	(HEAD -> master, tag: v1.9.0)
51aff4f add imap_url support (2020-07-26)
864e2f5 allow multiple rdoc_url and cgit_url values (2020-07-26)
0be43ba olddoc 1.8.0 - add man2html generator (2019-12-15)
	(tag: v1.8.0)
3a6ffe1 replace URI.escape with CGI.escape (2019-12-15)
9910c59 add man2html generator (2019-12-12)
597e495 olddoc 1.7.1 - minor cleanups for dark216 (2019-05-11)
	(tag: v1.7.1)
000ec0a dark216: adjust heredoc to stop confusing rdoc (2019-05-11)
c5c9c15 dark216: disable text decoration on <a> tags for light users, too (2019-05-11)
935fcc9 dark216: disable text decoration on <a> tags (2019-04-29)

$ git cat-file blob HEAD:README
= olddoc - old-fashioned Ruby documentation generator

olddoc contains old-fashioned document generators for those who do not
wish to impose bloated, new-fangled web cruft on their readers.

olddoc contains dark216, a HTML generator without any images, frames,
or JavaScript.  It is designed for users of text-based browsers
and/or low-bandwidth connections; yet respects user preference for
light color schemes in new CSS browsers while favoring darkness for
power savings on OLED and CRT displays.  dark216 focuses on text as
it is the lowest common denominator for accessibility and compatibility
with people and hardware.

== Reasons

* No CSS required.  Encouraging users to use CSS leads to problems like
  copy-paste hijacking: https://thejh.net/misc/website-terminal-copy-paste
  External CSS also increases page load time as it often blocks page
  rendering.  Asynchronous loading of CSS also causes accessibility
  problems as links/buttons may move as a user attempts to click.

* No JavaScript.  There is a constant barrage of security and
  client-side performance problems associated with it.  It's also
  unreasonable to expect users to rely on LibreJS and inspect every
  piece of JS they run.

* No frames.  Frames are an accessibility hassle and unfriendly
  to users of tiny screens on mobile devices and text-based browsers.

* No images.  Not everyone can view or afford bandwidth to load images.
  This also reduces the potential for security vulnerabilities as less
  code gets run.  Furthermore, loading the wrong image in a public
  place can get you arrested (or worse).

Encourage readers to simplify and speed up their browsing experience.
They can disable CSS, JavaScript, and images in their browser without
missing out!

== Usage

	gem install olddoc
	rdoc -f dark216

You can also use olddoc to generate NEWS entries
assuming you have git tags, a README file and .olddoc.yml

	olddoc prepare

And "olddoc merge" to merge instances of "olddoc_placeholder" in
an HTML file with HTML fragments generated with other tools
such as pandoc(1).  This requries an appropriately configured
.olddoc.yml with a "merge_html" section see olddoc(5)

== Source code

	git clone https://80x24.org/olddoc.git

Please use git-format-patch(1) and git-send-email(1) distributed with
the git(7) suite for generating and sending patches.  Please format
pull requests with the git-request-pull(1) script (also distributed
with git(7)) and send them via email to <olddoc-public@80x24.org>

== Contact

All feedback (comments, results, feature requests, bug reports, patches,
pull-requests) via plain-text email is very much appreciated.

Please send plain-text email to us at <olddoc-public@80x24.org>
Use reply-to-all as we do not require any sort of subscription.
HTML will not be read.  olddoc is for GUI-phobes, by GUI-phobes.
We archive all of our mail publically at:


== License

olddoc is copyrighted Free Software by all contributors, see logs
in revision control for names and email addresses of all of them.

olddoc is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

olddoc is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, see https://www.gnu.org/licenses/gpl-3.0.txt

# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
	--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
* master       olddoc 1.9.0 - imap_url support (2020-08-10)

# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
	--format='%(refname:short) %(subject) (%(creatordate:short))'
v1.9.0       olddoc 1.9.0 - imap_url support (2020-08-10) tar.gz
v1.8.0       olddoc 1.8.0 - add man2html generator (2019-12-15) tar.gz
v1.7.1       olddoc 1.7.1 - minor cleanups for dark216 (2019-05-11) tar.gz
v1.7.0       olddoc 1.7.0 - Earth day! (2019-04-22) tar.gz
v1.6.0       olddoc 1.6.0 (2019-01-07) tar.gz
v1.5.1       olddoc 1.5.1 - support rdoc 6.0 (2017-12-15) tar.gz
v1.5.0       olddoc 1.5.0 (2017-02-02) tar.gz
v1.4.0       olddoc 1.4.0 (2017-01-22) tar.gz
v1.3.0       olddoc 1.3.0 (2016-12-02) tar.gz
v1.2.0       olddoc 1.2.0 - multiple archive URLs (2016-01-09) tar.gz

# associated public inboxes:
# (number on the left is used for dev purposes)

git clone https://80x24.org/olddoc.git