From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,AWL,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.0 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id BF43020950; Thu, 2 Feb 2017 18:39:31 +0000 (UTC) Date: Thu, 2 Feb 2017 18:39:31 +0000 From: Eric Wong To: ruby-talk@ruby-lang.org, olddoc-public@80x24.org Cc: Daniel Ferreira Subject: [ANN] olddoc 1.5.0 - old-fashioned RDoc generator Message-ID: <20170202183931.GA10606@dcvr> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline List-Id: 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 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+