* [ANN] olddoc 1.2.0 - old-fashioned RDoc generator
@ 2016-01-09 22:34 5% 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 5%]
* [PATCH 3/4] tail: shorten the footer section
2016-01-07 1:36 5% [PATCH 0/4] bunch of updates for 1.2 Eric Wong
@ 2016-01-07 1:36 7% ` 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
Not every project uses git, and some misguided ones even
allow HTML email (not sure why those projects would be interested
in olddoc, though).
Anyways, the olddoc-public@80x24.org account will always be
configured to reject HTML email (or it'll be eaten by a spam filter).
---
lib/oldweb/_tail.rhtml | 38 +++++++++++++++-----------------------
1 file changed, 15 insertions(+), 23 deletions(-)
diff --git a/lib/oldweb/_tail.rhtml b/lib/oldweb/_tail.rhtml
index 522c312..0879572 100644
--- a/lib/oldweb/_tail.rhtml
+++ b/lib/oldweb/_tail.rhtml
@@ -3,27 +3,19 @@ public_email = @old_cfg['public_email']
private_email = @old_cfg['private_email']
ml_url = @old_cfg['ml_url']
nntp_url = @old_cfg['nntp_url']
-git_doc = 'https://kernel.org/pub/software/scm/git/docs/'
-se_url = "#{git_doc}git-send-email.html"
-rp_url = "#{git_doc}git-request-pull.html"
-if public_email && ml_url %><hr /><p>
-We love to hear from you!<br />
-Email patches (using <a
-href="<%= se_url %>">git send-email</a>),
-pull requests (formatted using <a
-href="<%= rp_url %>">git request-pull</a>), questions, bug reports,
-suggestions, etc. to us publically at:<br /><a
-href="mailto:<%= public_email %>"><%= public_email %></a><br />
-Mail archives are available at: <a
-href="<%= ml_url %>"><%= ml_url %></a><br />
-Please send plain-text email only and do not waste bandwidth on HTML mail,
-HTML mail will not be read.<br />
-Quote as little as reasonable and do not <a
-href="http://catb.org/jargon/html/T/top-post.html">top post</a>.<br /><% end
-if nntp_url %>NNTP archives are available at: <a
-href="<%= nntp_url %>"><%= nntp_url %></a><% end
-if private_email %>
-For sensitive topics, email us privately at:
-<a
-href="mailto:<%= private_email %>"><%= private_email %></a><% end %>
+if public_email && ml_url %><hr /><pre>
+mail archives: <a
+href="<%= ml_url %>"><%= ml_url %></a> mailto:<a
+href="mailto:<%= public_email %>"><%=
+public_email
+%></a>
+<% end
+if nntp_url %>NNTP archives: <a
+href="<%= nntp_url %>"><%= nntp_url %></a>
+<%
+end
+if private_email
+%>private mail: <a
+href="mailto:<%= private_email %>"><%= private_email %></a><%
+end %></pre>
--
EW
^ permalink raw reply related [relevance 7%]
* [PATCH 0/4] bunch of updates for 1.2
@ 2016-01-07 1:36 5% Eric Wong
2016-01-07 1:36 7% ` [PATCH 3/4] tail: shorten the footer section 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 5%]
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 5% [PATCH 0/4] bunch of updates for 1.2 Eric Wong
2016-01-07 1:36 7% ` [PATCH 3/4] tail: shorten the footer section Eric Wong
2016-01-09 22:34 5% [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).