olddoc 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b153359b84321c4656018665d07338bbac666d12f905c45db9be3fc9c4944fd4
-  data.tar.gz: 47a8e3dabb100a59c5f3a3b28e646906ad0fb67467f66a8b71d8d09ed3463d70
+  metadata.gz: 14790478480a3a9995861df417903d8e6cadc88441668e4c1ab1b4091a365cf0
+  data.tar.gz: d68495eb66d05dab730829d01ecb299270f38856512f0a3bcb2b606c33b0179f
 SHA512:
-  metadata.gz: d38527a6d8c1c8919b7c38e91a4aeaab3872d130d464df377a96e6ef0ed159c21c12b5e0cc9621ca2b0e578c7f7ba16df51826e8671988861338d9810f560f6e
-  data.tar.gz: a308d13fb8bea2bd1849b357fa776ec834ea2932a0eaddfc1d4ceb8d7f6cc2b27ff022b6ef4f88b76acd4858b75774e969a3f4d7c4b36b7aac358fe9c8892789
+  metadata.gz: 4d0027f5d3ae1a5d15f846896ecdfa1aec567ac666937b7c5055a279d7482b126ebcc561c4868a55a67ca1afba89471a8a518bb5449fb81d7b10273a69955e5c
+  data.tar.gz: 3cf5ef6d6bf09617f0d9ab64bca5caf76c8f8c0a878d67f569a4164b315d86cf75270447dc3089a1d0bf5b19314858667ef67e916dbb0d83fce9ae15bb8932b0

data/Documentation/.gitignore

@@ -2,3 +2,4 @@
 *.1
 *.5
 *.html
+*.txt

data/Documentation/GNUmakefile

@@ -1,26 +1,32 @@
-# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# Copyright (C) 2015-2019 all contributors <olddoc-public@80x24.org>
 # License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 all::
 
 INSTALL = install
-PANDOC = pandoc
-PANDOC_OPTS = -f markdown --email-obfuscation=none
-pandoc = $(PANDOC) $(PANDOC_OPTS)
-pandoc_html = $(pandoc) --toc -t html --no-wrap
+POD2MAN = pod2man
+-include ../GIT-VERSION-FILE
+release := olddoc $(VERSION)
+POD2MAN_OPTS = -v -r '$(release)' --stderr -d 1994-10-02 -c 'olddoc user manual'
+pod2man = $(POD2MAN) $(POD2MAN_OPTS)
+POD2TEXT = pod2text
+POD2TEXT_OPTS = --stderr
+pod2text = $(POD2TEXT) $(POD2TEXT_OPTS)
 
+m1 =
+m1 += olddoc.1
 
-man1 := olddoc.1
-man5 := olddoc.5
-man7 :=
+m5 =
+m5 += olddoc.5
 
-html1 := $(addsuffix .html, $(man1))
-html5 := $(addsuffix .html, $(man5))
-html7 := $(addsuffix .html, $(man7))
+m7 =
+
+man1 := $(m1)
+man5 := $(m5)
+man7 := $(m7)
 
 all:: man
 
 man: $(man1) $(man5) $(man7)
-html: $(html1) $(html5) $(html7)
 
 prefix ?= $(HOME)
 mandir ?= $(prefix)/share/man
@@ -30,24 +36,47 @@ man7dir = $(mandir)/man7
 
 gem-man: man
 	$(INSTALL) -d -m 755 ../man
-	test -z "$(man1)" || $(INSTALL) -m 644 $(man1) ../man
-	test -z "$(man5)" || $(INSTALL) -m 644 $(man5) ../man
+	$(INSTALL) -m 644 $(man1) ../man
+	$(INSTALL) -m 644 $(man5) ../man
 	test -z "$(man7)" || $(INSTALL) -m 644 $(man7) ../man
 
 install-man: man
-	$(INSTALL) -d -m 755 $(DESTDIR)$(mandir)
-	test -z "$(man1)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
-	test -z "$(man5)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 	test -z "$(man7)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
-	test -z "$(man1)" || $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
-	test -z "$(man5)" || $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
+	$(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
+	$(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
 	test -z "$(man7)" || $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
 
-%: %.txt
-	$(pandoc) -s -t man < $< > $@+ && mv $@+ $@
+%.1 : %.1.pod
+	$(pod2man) -s 1 $< $@+
+	mv $@+ $@
+
+%.5 : %.5.pod
+	$(pod2man) -s 5 $< $@+
+	mv $@+ $@
+
+%.7 : %.7.pod
+	$(pod2man) -s 7 $< $@+
+	mv $@+ $@
+
+mantxt = $(addsuffix .txt, $(m1) $(m5) $(m7))
+
+txt :: $(mantxt)
+
+all :: txt
+
+%.txt : %.pod
+	$(pod2text) $< $@+
+	touch -r $< $@+
+	mv $@+ $@
 
-%.html : %.txt
-	$(pandoc_html) < $< > $@+ && mv $@+ $@
+html : podtxt2html $(mantxt)
+	./podtxt2html $(mantxt)
 
 clean::
-	$(RM) $(man1) $(man5) $(man7) $(html1) $(html5) $(html7)
+	$(RM) $(man1) $(man5) $(man7)
+	$(RM) $(addsuffix .txt.gz, $(m1) $(m5) $(m7))
+	$(RM) $(addsuffix .txt, $(m1) $(m5) $(m7))
+	$(RM) $(addsuffix .html, $(subst .,_,$(m1) $(m5) $(m7)))
+	$(RM) $(addsuffix .html.gz, $(subst .,_,$(m1) $(m5) $(m7)))

data/Documentation/olddoc.1.pod

@@ -0,0 +1,21 @@
+=head1 NAME
+
+olddoc - old-fashioned RDoc HTML generator
+
+=head1 SYNOPSYS
+
+olddoc prepare
+
+rdoc -f oldweb
+
+rdoc -f dark216
+
+=head1 DESCRIPTION
+
+olddoc features dark216, and old-fashioned RDoc HTML generator.
+You can also use "olddoc prepare" to generate NEWS files from
+git tags.
+
+=head1 SEE ALSO
+
+L<olddoc(5)>

data/Documentation/{olddoc.5.txt → olddoc.5.pod}

@@ -1,19 +1,17 @@
-% olddoc(1) olddoc user manual
-
-# NAME
+=head1 NAME
 
 .olddoc.yml - olddoc config file format
 
-# SYNOPSIS
+=head1 SYNOPSIS
 
 A YAML file in the top-level project directory named ".olddoc.yml"
 
-# DESCRIPTION
+=head1 DESCRIPTION
 
 As olddoc favors consistency over configuration, there is minimal
 configuration to deal with.
 
-# KEYS
+=head1 KEYS
 
 `rdoc_url`, `cgit_url`, and `nntp_url` should be obvious
 
@@ -21,9 +19,8 @@ configuration to deal with.
 HTML file that will be merged into RDoc after-the-fact.  It is useful
 for merging non-RDoc generated HTML into the project.
 
-`ml_url` is the mailing list archive location.
-`public_email` is the email address of a publically archived mailing list
-at `ml_url`
+`ml_url` is the mail archive location.
+`public_email` is the email address of a mail archived at `ml_url`
 
 As of olddoc 1.2.0, `ml_url` and `nntp_url` may be YAML arrays
 with multiple URLs.
@@ -33,6 +30,6 @@ 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
+=head1 SEE ALSO
 
-olddoc(1)
+L<olddoc(1)>

data/Documentation/podtxt2html

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby
+# Copyright (C) 2019 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
+
+# pod2html isn't to my liking, and we need to generate anchors
+# compatible with what pandoc was generating to avoid breaking
+# links.  Takes pod2text-generated text and transforms it to
+# an HTML fragment
+
+txts = ARGV
+links = {}
+txts.each do |f|
+  if f =~ /(\A[\w\-]+)\.(\d)\.txt\z/
+    base = $1
+    section = $2
+    links["#{base}(#{section})"] = "#{base}_#{section}.html"
+  else
+    abort "#{f} is not of <BASE>.<SECTION>.txt\n"
+  end
+end
+
+linkre = links.keys.map { |x| Regexp.escape(x) }.join('|')
+
+sections = '[A-Z][A-Z ]+'
+txts.each do |f|
+  str = File.read(f)
+  str = str.split(/^(#{sections})$/mo)
+  str = str.map! do |s|
+    case s
+    when /\A(#{sections})$/o
+      # this is to be compatible with HTML fragments pandoc used
+      sec = $1
+      anchor = sec.downcase.tr(' ', '-')
+      %Q(<h1\nid=#{anchor}>#{sec}</h1>)
+    else
+      s.encode!(xml: :text)
+      s.gsub!(/\b(#{linkre})/mo) do |m|
+        manref = $1
+        if url = links[manref]
+          %Q(<a\nhref="#{url}">#{manref}</a>)
+        else
+          manref
+        end
+      end
+      s.rstrip!
+      s.empty? ? '' : "<pre>#{s}</pre>"
+    end # case s
+  end.join
+
+  html = f.sub(/.txt\z/, '.html')
+  tmp = html + '+'
+  File.open(tmp, 'w') { |f| f.write(str) }
+  File.rename(tmp, html)
+end

data/GIT-VERSION-GEN

@@ -5,7 +5,7 @@
 CONSTANT = "Olddoc::VERSION"
 RVF = "lib/olddoc/version.rb"
 GVF = "GIT-VERSION-FILE"
-DEF_VER = "v1.6.0"
+DEF_VER = "v1.7.0"
 vn = DEF_VER.dup
 
 # First see if there is a version file (included in release tarballs),

data/GNUmakefile

@@ -41,7 +41,7 @@ doc: $(placeholders)
 	$(MAKE) -C Documentation html
 	rm -rf doc
 	olddoc prepare
-	rdoc --debug -f oldweb
+	rdoc --debug -f dark216
 	olddoc merge
 	ln NEWS.atom.xml doc/
 

data/README

@@ -3,15 +3,17 @@
 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
+olddoc contains dark216, a HTML generator without any images, frames,
+or JavaScript.  It is designed for users of text-based browsers
+and/or low-bandwidth connections; yet respects user preference for
+light color schemes in new CSS browsers while favoring darkness for
+power savings on OLED and CRT displays.  dark216 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
+* No CSS required.  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
@@ -38,7 +40,7 @@ missing out!
 
 	gem install olddoc
 	cd $ANY_RDOC_USING_RUBY_PROJECT
-	rdoc -f oldweb
+	rdoc -f dark216
 
 You can also use olddoc to generate NEWS entries
 assuming you have git tags, a README file and .olddoc.yml
@@ -62,14 +64,15 @@ with git(7)) and send them via email to <olddoc-public@80x24.org>
 == Contact
 
 All feedback (comments, results, feature requests, bug reports, patches,
-pull-requests) via plain-text mail to the mailing list is very much
-appreciated.
+pull-requests) via plain-text email is very much appreciated.
 
-Please send plain-text mail to the list at <olddoc-public@80x24.org>
+Please send plain-text email to us at <olddoc-public@80x24.org>
+Use reply-to-all as we do not require any sort of subscription.
 HTML will not be read.  olddoc is for GUI-phobes, by GUI-phobes.
-Mailing list archives available at https://80x24.org/olddoc-public/
-and nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
-No subscription will ever be necessary to post to the mailing list.
+We archive all of our mail publically at:
+
+	https://80x24.org/olddoc-public/
+	nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
 
 == License
 

data/Rakefile

@@ -21,7 +21,7 @@ task :rsync_docs do
     gz
   end
 
-  files = `git ls-files Documentation/*.txt`.split(/\n/)
+  files = `git ls-files -o Documentation/*.txt`.split(/\n/)
   files.concat(top)
   files.concat(%w(NEWS NEWS.atom.xml))
   files.concat(Dir["doc/*.html"].to_a)

data/lib/dark216.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 2019 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_relative 'oldweb'
+
+# dark216 is an \RDoc template and not intended as a programming API.
+# It respect prefers-color-scheme:light on newer browsers with CSS
+# support, but favors darkness for power-savings.
+# You may specify it as an \RDoc formatter:
+#
+#   rdoc -f dark216 ...
+class Dark216 < Oldweb
+  RDoc::RDoc.add_generator(self) # :nodoc:
+  include ERB::Util # :nodoc:
+
+  # description of the generator
+  DESCRIPTION = 'minimal dark HTML generator'
+
+  # default to a dark, web-safe (216 color) palette for power-savings.
+  # Color-capable browsers can respect the prefers-color-scheme:light
+  # @media query (browser support a work-in-progress)
+  STYLE = <<''.gsub(/^\s*/m, '').delete!("\n") # :nodoc:
+@media screen {
+  *{background:#000;color:#ccc}
+  a{color:#69f}
+  a:visited{color:#96f}
+}
+@media screen AND (prefers-color-scheme:light) {
+  *{background:#fff;color:#333}
+  a{color:#00f}
+  a:visited{color:#808}
+}
+
+  def initialize(*args) # :nodoc:
+    super
+    @oldweb_style = STYLE
+  end
+end
+# :startdoc:

data/lib/olddoc.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# Copyright (C) 2015-2019 all contributors <olddoc-public@80x24.org>
 # License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 module Olddoc # :nodoc:
   autoload :Gemspec, 'olddoc/gemspec'
@@ -16,3 +16,4 @@ module Olddoc # :nodoc:
   end
 end
 require_relative 'oldweb'
+require_relative 'dark216'

data/lib/oldweb.rb

@@ -91,6 +91,7 @@ class Oldweb
       cgit_url << '#n%d' # lineno
       @old_vcs_url = cgit_url
     end
+    @oldweb_style = nil # used by dark216
   end
 
   def generate # :nodoc:

data/lib/oldweb/_head.rhtml

@@ -8,4 +8,8 @@ type="application/atom+xml" /><%
 end
 %><meta
 http-equiv="Content-Type"
-content="text/html; charset=<%= @options.charset %>">
+content="text/html; charset=<%= @options.charset %>"><%
+if @oldweb_style
+%><style><%= @oldweb_style %></style><%
+end
+%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: olddoc
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - olddoc hackers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -45,8 +45,9 @@ files:
 - COPYING
 - Documentation/.gitignore
 - Documentation/GNUmakefile
-- Documentation/olddoc.1.txt
-- Documentation/olddoc.5.txt
+- Documentation/olddoc.1.pod
+- Documentation/olddoc.5.pod
+- Documentation/podtxt2html
 - GIT-VERSION-GEN
 - GNUmakefile
 - INSTALL
@@ -55,6 +56,7 @@ files:
 - Rakefile
 - TODO
 - bin/olddoc
+- lib/dark216.rb
 - lib/olddoc.rb
 - lib/olddoc/gemspec.rb
 - lib/olddoc/history.rb
@@ -104,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: old-fashioned Ruby documentation generator

data/Documentation/olddoc.1.txt

@@ -1,21 +0,0 @@
-% olddoc(1) olddoc user manual
-
-# NAME
-
-olddoc - old-fashioned RDoc HTML generator
-
-# SYNOPSIS
-
-`olddoc` prepare
-
-`rdoc` -f oldweb
-
-# DESCRIPTION
-
-olddoc features oldweb, and old-fashioned RDoc HTML generator.
-You can also use "olddoc prepare" to generate NEWS files from
-git tags.
-
-# SEE ALSO
-
-olddoc(5)