* [ANN] olddoc 1.2.0 - old-fashioned RDoc generator
@ 2016-01-09 22:34 4% Eric Wong
0 siblings, 0 replies; 3+ results
From: Eric Wong @ 2016-01-09 22:34 UTC (permalink / raw)
To: ruby-talk, olddoc-public
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: http://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.2.0 - multiple archive URLs
Users using .olddoc.yml to add links to mailing list archives
will now be pleased to know "ml_url" and "nntp_url" fields
accept arrays.
This release also fixes bold highlighting of the current
module/class page for APIs.
7 changes since 1.1.2:
bold class bar to highlight current page
copyright updates for 2016
tail: shorten the footer section
head: use old-style <meta> tags for compatibility
nodoc some internals
tail: support multiple URLs for archives
tail: fix divider when private email does not exist
* http://80x24.org/olddoc/ - homepage + sample
* http://80x24.org/olddoc-public/ - ML archives
* nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
* olddoc-public@80x24.org - public mailing list
* git clone git://80x24.org/olddoc
* license: GPL-3.0+
--
EW
^ permalink raw reply [relevance 4%]
* [PATCH 0/4] bunch of updates for 1.2
@ 2016-01-07 1:36 7% Eric Wong
2016-01-07 1:36 4% ` [PATCH 2/4] copyright updates for 2016 Eric Wong
0 siblings, 1 reply; 3+ results
From: Eric Wong @ 2016-01-07 1:36 UTC (permalink / raw)
To: olddoc-public
A few minor fixes and copyright update for 2016
4 changes:
bold class bar to highlight current page
copyright updates for 2016
tail: shorten the footer section
head: use old-style <meta> tags for compatibility
Documentation/GNUmakefile | 4 ++--
GNUmakefile | 4 ++--
Rakefile | 4 ++--
lib/olddoc.rb | 4 ++--
lib/olddoc/gemspec.rb | 2 ++
lib/olddoc/history.rb | 4 ++--
lib/olddoc/merge.rb | 4 ++--
lib/olddoc/news_atom.rb | 4 ++--
lib/olddoc/news_rdoc.rb | 6 +++---
lib/olddoc/prepare.rb | 4 ++--
lib/olddoc/readme.rb | 4 ++--
lib/oldweb.rb | 4 ++--
lib/oldweb/_head.rhtml | 10 +++++++---
lib/oldweb/_sidebar_classes.rhtml | 6 +++++-
lib/oldweb/_tail.rhtml | 38 +++++++++++++++-----------------------
olddoc.gemspec | 4 ++--
16 files changed, 54 insertions(+), 52 deletions(-)
^ permalink raw reply [relevance 7%]
* [PATCH 2/4] copyright updates for 2016
2016-01-07 1:36 7% [PATCH 0/4] bunch of updates for 1.2 Eric Wong
@ 2016-01-07 1:36 4% ` Eric Wong
0 siblings, 0 replies; 3+ results
From: Eric Wong @ 2016-01-07 1:36 UTC (permalink / raw)
To: olddoc-public; +Cc: Eric Wong
While we're at it, switch to the shorter, SPDX-approved "GPL-3.0+"
identifier instead of the more verbose "GPLv3 or later" for consistency.
The formatting changed slightly to allow us to use the update-copyright
script in gnulib[1] In the future:
git ls-files | UPDATE_COPYRIGHT_HOLDER='all contributors' \
UPDATE_COPYRIGHT_USE_INTERVALS=2 \
xargs /path/to/gnulib/build-aux/update-copyright
[1] git://git.savannah.gnu.org/gnulib.git
---
Documentation/GNUmakefile | 4 ++--
GNUmakefile | 4 ++--
Rakefile | 4 ++--
lib/olddoc.rb | 4 ++--
lib/olddoc/gemspec.rb | 2 ++
lib/olddoc/history.rb | 4 ++--
lib/olddoc/merge.rb | 4 ++--
lib/olddoc/news_atom.rb | 4 ++--
lib/olddoc/news_rdoc.rb | 6 +++---
lib/olddoc/prepare.rb | 4 ++--
lib/olddoc/readme.rb | 4 ++--
lib/oldweb.rb | 4 ++--
olddoc.gemspec | 4 ++--
13 files changed, 27 insertions(+), 25 deletions(-)
diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile
index 5e47833..0de5043 100644
--- a/Documentation/GNUmakefile
+++ b/Documentation/GNUmakefile
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
all::
INSTALL = install
diff --git a/GNUmakefile b/GNUmakefile
index 1087882..f67cab6 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
all::
pkg = olddoc
RUBY = ruby
diff --git a/Rakefile b/Rakefile
index a466d6c..1cbd0f9 100644
--- a/Rakefile
+++ b/Rakefile
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
require 'tempfile'
include Rake::DSL
task :rsync_docs do
diff --git a/lib/olddoc.rb b/lib/olddoc.rb
index 18495e2..1621f85 100644
--- a/lib/olddoc.rb
+++ b/lib/olddoc.rb
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
module Olddoc
VERSION = '1.1.2'
diff --git a/lib/olddoc/gemspec.rb b/lib/olddoc/gemspec.rb
index 73382ab..f5f008d 100644
--- a/lib/olddoc/gemspec.rb
+++ b/lib/olddoc/gemspec.rb
@@ -1,3 +1,5 @@
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
# helper methods for gemspecs
module Olddoc::Gemspec
include Olddoc::Readme
diff --git a/lib/olddoc/history.rb b/lib/olddoc/history.rb
index b817d2d..595994d 100644
--- a/lib/olddoc/history.rb
+++ b/lib/olddoc/history.rb
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
require 'uri'
module Olddoc::History
diff --git a/lib/olddoc/merge.rb b/lib/olddoc/merge.rb
index da5bd07..b5dae65 100644
--- a/lib/olddoc/merge.rb
+++ b/lib/olddoc/merge.rb
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
class Olddoc::Merge
def initialize(opts)
diff --git a/lib/olddoc/news_atom.rb b/lib/olddoc/news_atom.rb
index 7c63db2..a093e64 100644
--- a/lib/olddoc/news_atom.rb
+++ b/lib/olddoc/news_atom.rb
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
require 'builder'
module Olddoc::NewsAtom
diff --git a/lib/olddoc/news_rdoc.rb b/lib/olddoc/news_rdoc.rb
index cc51bec..e8c6a34 100644
--- a/lib/olddoc/news_rdoc.rb
+++ b/lib/olddoc/news_rdoc.rb
@@ -1,7 +1,7 @@
# -*- encoding: utf-8 -*-
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
-
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
+#
require 'tempfile'
module Olddoc::NewsRdoc
diff --git a/lib/olddoc/prepare.rb b/lib/olddoc/prepare.rb
index 1ed66a0..f42bd04 100644
--- a/lib/olddoc/prepare.rb
+++ b/lib/olddoc/prepare.rb
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
require 'uri'
class Olddoc::Prepare
diff --git a/lib/olddoc/readme.rb b/lib/olddoc/readme.rb
index e593517..423d18b 100644
--- a/lib/olddoc/readme.rb
+++ b/lib/olddoc/readme.rb
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
# helpers for parsing the top-level README file
module Olddoc::Readme
diff --git a/lib/oldweb.rb b/lib/oldweb.rb
index 12ce876..af62050 100644
--- a/lib/oldweb.rb
+++ b/lib/oldweb.rb
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
# Loosely derived from Darkfish in the main rdoc distribution
require 'rdoc'
require 'erb'
diff --git a/olddoc.gemspec b/olddoc.gemspec
index 79f4579..def2265 100644
--- a/olddoc.gemspec
+++ b/olddoc.gemspec
@@ -1,5 +1,5 @@
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
-# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
$LOAD_PATH << 'lib'
require 'olddoc'
extend Olddoc::Gemspec
--
EW
^ permalink raw reply related [relevance 4%]
Results 1-3 of 3 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2016-01-07 1:36 7% [PATCH 0/4] bunch of updates for 1.2 Eric Wong
2016-01-07 1:36 4% ` [PATCH 2/4] copyright updates for 2016 Eric Wong
2016-01-09 22:34 4% [ANN] olddoc 1.2.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).