tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
* Consolidate stylesheets
@ 2015-10-30 20:01 Anthony J. Bentley
  2015-11-05 17:54 ` Ingo Schwarze
  0 siblings, 1 reply; 2+ messages in thread
From: Anthony J. Bentley @ 2015-10-30 20:01 UTC (permalink / raw)
  To: tech

Hi,

Right now the mandoc source tree contains three CSS files. That's too
many. IMO, one can be deleted right off the bat, and the other two merged.

From example.style.css:

 * This is an example style-sheet provided for mandoc(1) and the -Thtml
 * or -Txhtml output mode.
 * It mimics the appearance of the legacy man.cgi output.
 
This is apparently the same stylesheet as the man.css used on
mdocml.bsd.lv's man.cgi instance, and almost the same as the one on
www.openbsd.org's man.cgi. There's really no point in mimicking the
legacy man.cgi output, which was just a copy of the nroff output. This
is HTML, and mandoc's semantic output can look much better. There's no
reason for example.style.css to exist anymore.

Next, man-cgi.css:

    body     { font-family: Helvetica, Arial, sans-serif; }

This rule duplicates one in style.css.

    body > div       { padding-left: 2em; padding-top: 1em; }

This rule is meant to apply to div that *aren't* specific to man.cgi.

All remaining rules in man-cgi.css use classes and ids that are specific
to man.cgi, so they won't affect static pages generated by mandoc(1).
Thus, there's no harm in merging man-cgi.css and style.css.

Not sure what to do about filenames, since neither of the man.cgi
instances seem to use the filenames from the repo. I've changed all
references in the makefile and manuals to point to a single file,
style.css.

The diff below deletes example.style.css, merges the contents of
man-cgi.css into style.css, removes man-cgi.css, and tells man.cgi to
generate only one css link element.

There may be more improvements that need to be made, but this is a
start, since now changes only need to be made to one obvious file.


Index: Makefile
===================================================================
RCS file: /cvs/mdocml/Makefile,v
retrieving revision 1.470
diff -u -p -r1.470 Makefile
--- Makefile	20 Oct 2015 02:01:31 -0000	1.470
+++ Makefile	30 Oct 2015 19:57:51 -0000
@@ -125,7 +125,6 @@ DISTFILES	 = INSTALL \
 		   configure.local.example \
 		   demandoc.1 \
 		   eqn.7 \
-		   example.style.css \
 		   gmdiff \
 		   html.h \
 		   lib.in \
@@ -135,7 +134,6 @@ DISTFILES	 = INSTALL \
 		   libroff.h \
 		   main.h \
 		   makewhatis.8 \
-		   man-cgi.css \
 		   man.1 \
 		   man.7 \
 		   man.cgi.8 \
@@ -362,7 +360,6 @@ base-install: base-build
 	$(INSTALL_MAN) eqn.7 $(DESTDIR)$(MANDIR)/man7/${MANM_EQN}.7
 	$(INSTALL_MAN) tbl.7 $(DESTDIR)$(MANDIR)/man7/${MANM_TBL}.7
 	$(INSTALL_MAN) mandoc_char.7 $(DESTDIR)$(MANDIR)/man7
-	$(INSTALL_DATA) example.style.css $(DESTDIR)$(EXAMPLEDIR)
 
 db-install: base-build
 	mkdir -p $(DESTDIR)$(BINDIR)
@@ -389,8 +386,7 @@ cgi-install: cgi-build
 	mkdir -p $(DESTDIR)$(WWWPREFIX)/man/mandoc/man1
 	mkdir -p $(DESTDIR)$(WWWPREFIX)/man/mandoc/man8
 	$(INSTALL_PROGRAM) man.cgi $(DESTDIR)$(CGIBINDIR)
-	$(INSTALL_DATA) example.style.css $(DESTDIR)$(HTDOCDIR)/man.css
-	$(INSTALL_DATA) man-cgi.css $(DESTDIR)$(HTDOCDIR)
+	$(INSTALL_DATA) style.css $(DESTDIR)$(HTDOCDIR)
 	$(INSTALL_MAN) apropos.1 $(DESTDIR)$(WWWPREFIX)/man/mandoc/man1/
 	$(INSTALL_MAN) man.cgi.8 $(DESTDIR)$(WWWPREFIX)/man/mandoc/man8/
 
Index: cgi.c
===================================================================
RCS file: /cvs/mdocml/cgi.c,v
retrieving revision 1.112
diff -u -p -r1.112 cgi.c
--- cgi.c	22 Oct 2015 22:06:43 -0000	1.112
+++ cgi.c	30 Oct 2015 19:57:52 -0000
@@ -377,9 +377,7 @@ resp_begin_html(int code, const char *ms
 	       "<HTML>\n"
 	       "<HEAD>\n"
 	       "<META CHARSET=\"UTF-8\" />\n"
-	       "<LINK REL=\"stylesheet\" HREF=\"%s/man-cgi.css\""
-	       " TYPE=\"text/css\" media=\"all\">\n"
-	       "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""
+	       "<LINK REL=\"stylesheet\" HREF=\"%s/style.css\""
 	       " TYPE=\"text/css\" media=\"all\">\n"
 	       "<TITLE>%s</TITLE>\n"
 	       "</HEAD>\n"
Index: example.style.css
===================================================================
RCS file: example.style.css
diff -N example.style.css
--- example.style.css	10 Feb 2015 08:05:30 -0000	1.55
+++ /dev/null	1 Jan 1970 00:00:00 -0000
@@ -1,114 +0,0 @@
-/* $Id: example.style.css,v 1.55 2015/02/10 08:05:30 schwarze Exp $ */
-/*
- * This is an example style-sheet provided for mandoc(1) and the -Thtml
- * or -Txhtml output mode.
- * It mimics the appearance of the legacy man.cgi output.
- * See mdoc(7) and man(7) for macro explanations.
- */
-
-div.mandoc			{ min-width: 102ex;
-				  width: 102ex;
-				  font-family: monospace; } /* This is the outer node of all mandoc -T[x]html documents. */
-div.mandoc h1			{ margin-bottom: 0ex; font-size: inherit; margin-left: -4ex; } /* Section header (Sh, SH). */
-div.mandoc h2			{ margin-bottom: 0ex; font-size: inherit; margin-left: -2ex; } /* Sub-section header (Ss, SS). */
-div.mandoc table		{ width: 100%; margin-top: 0ex; margin-bottom: 0ex; } /* All tables. */
-div.mandoc td			{ vertical-align: top; } /* All table cells. */
-div.mandoc p			{ } /* Paragraph: Pp, Lp. */
-div.mandoc blockquote		{ margin-left: 5ex; margin-top: 0ex; margin-bottom: 0ex; } /* D1, Dl. */
-div.mandoc div.section		{ margin-bottom: 2ex; margin-left: 5ex; } /* Sections (Sh, SH). */
-div.mandoc div.subsection	{ } /* Sub-sections (Ss, SS). */
-div.mandoc table.synopsis	{ } /* SYNOPSIS section table. */
-div.mandoc table.foot		{ } /* Document footer. */
-div.mandoc td.foot-date		{ width: 50%; } /* Document footer: date. */
-div.mandoc td.foot-os		{ width: 50%;
-				  text-align: right; } /* Document footer: OS/source. */
-div.mandoc table.head		{ } /* Document header. */
-div.mandoc td.head-ltitle	{ width: 10%; } /* Document header: left-title. */
-div.mandoc td.head-vol		{ width: 80%;
-				  text-align: center; } /* Document header: volume. */
-div.mandoc td.head-rtitle	{ width: 10%;
-				  text-align: right; } /* Document header: right-title. */
-div.mandoc .display		{ } /* All Bd, D1, Dl. */
-div.mandoc .list		{ } /* All Bl. */
-div.mandoc i			{ } /* Italic: BI, IB, I, (implicit). */
-div.mandoc b			{ } /* Bold: SB, BI, IB, BR, RB, B, (implicit). */
-div.mandoc small		{ } /* Small: SB, SM. */
-div.mandoc .emph		{ font-style: italic; font-weight: normal; } /* Emphasis: Em, Bl -emphasis. */
-div.mandoc .symb		{ font-style: normal; font-weight: bold; } /* Symbolic: Sy, Ms, Bf -symbolic. */
-div.mandoc .lit			{ font-style: normal; font-weight: normal; font-family: monospace; } /* Literal: Dl, Li, Ql, Bf -literal, Bl -literal, Bl -unfilled. */
-div.mandoc i.addr		{ font-weight: normal; } /* Address (Ad). */
-div.mandoc i.arg		{ font-weight: normal; } /* Command argument (Ar). */
-div.mandoc span.author		{ } /* Author name (An). */
-div.mandoc b.cmd		{ font-style: normal; } /* Command (Cm). */
-div.mandoc b.config		{ font-style: normal; } /* Config statement (Cd). */
-div.mandoc span.define		{ } /* Defines (Dv). */
-div.mandoc span.desc		{ } /* Nd.  After em-dash. */
-div.mandoc b.diag		{ font-style: normal; } /* Diagnostic (Bl -diag). */
-div.mandoc span.env		{ } /* Environment variables (Ev). */
-div.mandoc span.errno		{ } /* Error string (Er). */
-div.mandoc i.farg		{ font-weight: normal; } /* Function argument (Fa, Fn). */
-div.mandoc i.file		{ font-weight: normal; } /* File (Pa). */
-div.mandoc b.flag		{ font-style: normal; } /* Flag (Fl, Cm). */
-div.mandoc b.fname		{ font-style: normal; } /* Function name (Fa, Fn, Rv). */
-div.mandoc i.ftype		{ font-weight: normal; } /* Function types (Ft, Fn). */
-div.mandoc b.includes		{ font-style: normal; } /* Header includes (In). */
-div.mandoc span.lib		{ } /* Library (Lb). */
-div.mandoc i.link-sec		{ font-weight: normal; } /* Section links (Sx). */
-div.mandoc b.macro		{ font-style: normal; } /* Macro-ish thing (Fd). */
-div.mandoc b.name		{ font-style: normal; } /* Name of utility (Nm). */
-div.mandoc span.opt		{ } /* Options (Op, Oo/Oc). */
-div.mandoc span.ref		{ } /* Citations (Rs). */
-div.mandoc span.ref-auth	{ } /* Reference author (%A). */
-div.mandoc i.ref-book		{ font-weight: normal; } /* Reference book (%B). */
-div.mandoc span.ref-city	{ } /* Reference city (%C). */
-div.mandoc span.ref-date	{ } /* Reference date (%D). */
-div.mandoc i.ref-issue		{ font-weight: normal; } /* Reference issuer/publisher (%I). */
-div.mandoc i.ref-jrnl		{ font-weight: normal; } /* Reference journal (%J). */
-div.mandoc span.ref-num		{ } /* Reference number (%N). */
-div.mandoc span.ref-opt		{ } /* Reference optionals (%O). */
-div.mandoc span.ref-page	{ } /* Reference page (%P). */
-div.mandoc span.ref-corp	{ } /* Reference corporate/foreign author (%Q). */
-div.mandoc span.ref-rep		{ } /* Reference report (%R). */
-div.mandoc span.ref-title	{ text-decoration: underline; } /* Reference title (%T). */
-div.mandoc span.ref-vol		{ } /* Reference volume (%V). */
-div.mandoc span.type		{ font-style: italic; font-weight: normal; } /* Variable types (Vt). */
-div.mandoc span.unix		{ } /* Unices (Ux, Ox, Nx, Fx, Bx, Bsx, Dx). */
-div.mandoc b.utility		{ font-style: normal; } /* Name of utility (Ex). */
-div.mandoc b.var		{ font-style: normal; } /* Variables (Rv). */
-div.mandoc a.link-ext		{ } /* Off-site link (Lk). */
-div.mandoc a.link-includes	{ } /* Include-file link (In). */
-div.mandoc a.link-mail		{ } /* Mailto links (Mt). */
-div.mandoc a.link-man		{ } /* Manual links (Xr). */
-div.mandoc a.link-ref		{ } /* Reference section links (%Q). */
-div.mandoc a.link-sec		{ } /* Section links (Sx). */
-div.mandoc dl.list-diag		{ } /* Formatting for lists.  See mdoc(7). */
-div.mandoc dt.list-diag		{ }
-div.mandoc dd.list-diag		{ }
-div.mandoc dl.list-hang		{ }
-div.mandoc dt.list-hang		{ }
-div.mandoc dd.list-hang		{ }
-div.mandoc dl.list-inset	{ }
-div.mandoc dt.list-inset	{ }
-div.mandoc dd.list-inset	{ }
-div.mandoc dl.list-ohang	{ }
-div.mandoc dt.list-ohang	{ }
-div.mandoc dd.list-ohang	{ margin-left: 0ex; }
-div.mandoc dl.list-tag		{ }
-div.mandoc dt.list-tag		{ }
-div.mandoc dd.list-tag		{ }
-div.mandoc table.list-col	{ }
-div.mandoc tr.list-col		{ }
-div.mandoc td.list-col		{ }
-div.mandoc ul.list-bul		{ list-style-type: disc; padding-left: 1em; }
-div.mandoc li.list-bul		{ }
-div.mandoc ul.list-dash		{ list-style-type: none; padding-left: 0em; }
-div.mandoc li.list-dash:before	{ content: "\2014  "; }
-div.mandoc ul.list-hyph		{ list-style-type: none; padding-left: 0em; }
-div.mandoc li.list-hyph:before	{ content: "\2013  "; }
-div.mandoc ul.list-item		{ list-style-type: none; padding-left: 0em; }
-div.mandoc li.list-item		{ }
-div.mandoc ol.list-enum		{ padding-left: 2em; }
-div.mandoc li.list-enum		{ }
-div.mandoc span.eqn		{ } /* Equation modes.  See eqn(7). */
-div.mandoc table.tbl		{ } /* Table modes.  See tbl(7). */
-div.mandoc div.spacer		{ margin: 1em 0; }
Index: man-cgi.css
===================================================================
RCS file: man-cgi.css
diff -N man-cgi.css
--- man-cgi.css	10 Feb 2015 08:05:30 -0000	1.7
+++ /dev/null	1 Jan 1970 00:00:00 -0000
@@ -1,13 +0,0 @@
-body				{ font-family: Helvetica, Arial, sans-serif; }
-body > div			{ padding-left: 2em;
-				  padding-top: 1em; }
-body > div#mancgi		{ padding-left: 0em;
-				  padding-top: 0em; }
-body > div.results		{ font-size: smaller; }
-#mancgi fieldset		{ text-align: center;
-				  border: thin solid silver;
-				  border-radius: 1em;
-			  	  font-size: small; }
-#mancgi input[name=expr] 	{ width: 25%; }
-.results td.title		{ vertical-align: top;
-				  padding-right: 1em; }
Index: man.cgi.8
===================================================================
RCS file: /cvs/mdocml/man.cgi.8,v
retrieving revision 1.11
diff -u -p -r1.11 man.cgi.8
--- man.cgi.8	14 Sep 2014 19:44:28 -0000	1.11
+++ man.cgi.8	30 Oct 2015 19:57:52 -0000
@@ -349,15 +349,10 @@ Can be overridden by
 The path to the server document root relative to the server root.
 This is part of the web server configuration and not specific to
 .Nm .
-.It Pa /htdocs/man-cgi.css
-A style sheet for general
-.Nm
-styling, referenced from each generated HTML page.
-.It Pa /htdocs/man.css
+.It Pa /htdocs/style.css
 A style sheet for
 .Xr mandoc 1
-HTML styling, referenced from each generated HTML page after
-.Pa man-cgi.css .
+HTML styling, referenced from each generated HTML page.
 .It Pa /man
 Default
 .Nm
Index: mandoc.1
===================================================================
RCS file: /cvs/mdocml/mandoc.1,v
retrieving revision 1.162
diff -u -p -r1.162 mandoc.1
--- mandoc.1	6 Oct 2015 15:33:29 -0000	1.162
+++ mandoc.1	30 Oct 2015 19:57:52 -0000
@@ -349,7 +349,7 @@ Equations rendered from
 blocks use MathML.
 .Pp
 The
-.Pa example.style.css
+.Pa style.css
 file documents style-sheet classes available for customising output.
 If a style-sheet is not specified with
 .Fl O Cm style ,
Index: style.css
===================================================================
RCS file: /cvs/mdocml/style.css,v
retrieving revision 1.31
diff -u -p -r1.31 style.css
--- style.css	10 Feb 2015 08:05:30 -0000	1.31
+++ style.css	30 Oct 2015 19:57:52 -0000
@@ -11,6 +11,19 @@
 
 html		{ max-width: 880px; margin-left: 1em; }
 body		{ font-size: smaller; font-family: Helvetica,Arial,sans-serif; }
+body > div			{ padding-left: 2em;
+				  padding-top: 1em; }
+body > div.mandoc,
+body > div#mancgi		{ padding-left: 0em;
+				  padding-top: 0em; }
+body > div.results		{ font-size: smaller; }
+#mancgi fieldset		{ text-align: center;
+				  border: thin solid silver;
+				  border-radius: 1em;
+			  	  font-size: small; }
+#mancgi input[name=expr] 	{ width: 25%; }
+.results td.title		{ vertical-align: top;
+				  padding-right: 1em; }
 h1		{ margin-bottom: 1ex; font-size: 110%; margin-left: -4ex; } /* Section header (Sh, SH). */
 h2		{ margin-bottom: 1ex; font-size: 105%; margin-left: -2ex; } /* Sub-section header (Ss, SS). */
 table		{ width: 100%; margin-top: 0ex; margin-bottom: 0ex; } /* All tables. */
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: Consolidate stylesheets
  2015-10-30 20:01 Consolidate stylesheets Anthony J. Bentley
@ 2015-11-05 17:54 ` Ingo Schwarze
  0 siblings, 0 replies; 2+ messages in thread
From: Ingo Schwarze @ 2015-11-05 17:54 UTC (permalink / raw)
  To: Anthony J. Bentley; +Cc: tech

Hi Anthony,

Anthony J. Bentley wrote on Fri, Oct 30, 2015 at 02:01:48PM -0600:

> Right now the mandoc source tree contains three CSS files.
> That's too many.

Thanks a lot for taking up this work.

> Not sure what to do about filenames,

The name "style.css" was too generic.
So i changed it to mandoc.css when committing your work.

> There may be more improvements that need to be made, but this is a
> start, since now changes only need to be made to one obvious file.

I'm looking forward to that.

Yours,
  Ingo
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2015-11-05 17:54 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-10-30 20:01 Consolidate stylesheets Anthony J. Bentley
2015-11-05 17:54 ` Ingo Schwarze

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 NNTP newsgroup(s).