* [ANN] olddoc 1.3.0 - old-fashioned RDoc generator
@ 2016-12-02 21:43 14% Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2016-12-02 21:43 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
This release supports the newly-released rdoc 5.x, but maintains
support for rdoc 4.2+. A new "source_code" accessor was
introduced to make us less git-centric to support other systems.
7 changes since 1.2.0:
_head: fix Content-Type charset attribute
add source_code accessor for tail footer
build: dynamically generate version number
_tail: do not mutate existing arrays
gemspec: support rdoc 5.x
build: avoid network usage in "install-gem" target
doc: olddoc.5: document "source_code" field
* 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 14%]
* [PATCH] doc: olddoc.5: document "source_code" field
@ 2016-12-02 21:28 8% Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2016-12-02 21:28 UTC (permalink / raw)
To: olddoc-public
New features need documentation.
---
Documentation/olddoc.5.txt | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/Documentation/olddoc.5.txt b/Documentation/olddoc.5.txt
index e2fdedb..8274330 100644
--- a/Documentation/olddoc.5.txt
+++ b/Documentation/olddoc.5.txt
@@ -28,6 +28,11 @@ at `ml_url`
As of olddoc 1.2.0, `ml_url` and `nntp_url` may be YAML arrays
with multiple URLs.
+As of olddoc 1.3.0, the `source_code` array may be any number of
+commands or URLs. This allows users of arbitrary version
+control systems to specify instructions for getting the code
+and not assume users are familiar with any particular system.
+
# SEE ALSO
olddoc(1)
--
EW
^ permalink raw reply related [relevance 8%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2016-12-02 21:28 8% [PATCH] doc: olddoc.5: document "source_code" field Eric Wong
2016-12-02 21:43 14% [ANN] olddoc 1.3.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).