* [ANN] olddoc 1.5.0 - old-fashioned RDoc generator
@ 2017-02-02 18:39 3% Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2017-02-02 18:39 UTC (permalink / raw)
To: ruby-talk, olddoc-public; +Cc: Daniel Ferreira
olddoc contains old-fashioned document generators for those who do not
wish to impose bloated, new-fangled web cruft on their readers.
olddoc contains oldweb, an HTML generator without any images, frames,
CSS, or JavaScript. It is designed for users of text-based browsers
and/or low-bandwidth connections. oldweb focuses on text as it is
the lowest common denominator for accessibility and compatibility
with people and hardware.
== Reasons
* No CSS. 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
cd $ANY_RDOC_USING_RUBY_PROJECT
rdoc -f oldweb
== Changes
olddoc 1.5.0
olddoc now avoids changing core RDoc behavior unless it is
actually specified. Thanks to Daniel Ferreira for noticing
this bug in [ruby-talk:437390]:
http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/437390
<CAPL_2g25ir4ZBJo652ao1EYB59ZvFHhpGef1V14QOV2SeVXLeA@mail.gmail.com>
We still assume any Ruby process will only use one RDoc template
in its lifetime, and not switch between them.
There are also a few minor documentation and code cleanups.
5 changes since olddoc v1.4.0:
update URLs to HTTPS
oldweb: apply LessHtml monkey patch late, at runtime
oldweb: use flat_map instead of flatten.map chain
oldweb: use native String#encode for (X)HTML escaping
README: add NNTP archive link for mailing list
* https://80x24.org/olddoc/ - homepage + sample
* https://80x24.org/olddoc-public/ - mailing list archives
* nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
* olddoc-public@80x24.org - public mailing list (no subscription * necessary)
* git clone git://80x24.org/olddoc
* license: GPL-3.0+
^ permalink raw reply [relevance 3%]
* [PATCH] README: add NNTP archive link for mailing list
@ 2017-02-02 18:31 7% Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2017-02-02 18:31 UTC (permalink / raw)
To: olddoc-public
And clarify that we will never require subscription.
---
README | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/README b/README
index 23f872b..bb261a6 100644
--- a/README
+++ b/README
@@ -68,7 +68,8 @@ appreciated.
Please send plain-text mail to the list at <olddoc-public@80x24.org>
HTML will not be read. olddoc is for GUI-phobes, by GUI-phobes.
Mailing list archives available at https://80x24.org/olddoc-public/
-No subscription is necessary to post to the mailing list.
+and nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
+No subscription will ever be necessary to post to the mailing list.
== License
--
EW
^ permalink raw reply related [relevance 7%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2017-02-02 18:31 7% [PATCH] README: add NNTP archive link for mailing list Eric Wong
2017-02-02 18:39 3% [ANN] olddoc 1.5.0 - old-fashioned RDoc generator Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/olddoc.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).