summaryrefslogtreecommitdiff
path: root/usr.bin/mandoc/mdoc_html.c
AgeCommit message (Collapse)Author
2018-05-09Fix a long-standing issue:Ingo Schwarze
Some macros (Nd, Oo) can contain blocks but rendered as elements that can only contain phrasing content, resulting in invalid HTML nesting. Switch them to <div>. Also move the related "display: inline" style from the HTML to the CSS. Reminded during a conversation with John Gardner.
2018-05-08Eliminate the class=It-* attributes.Ingo Schwarze
Cleaner HTML, more idiomatic CSS, and minus 30 lines of C code. Suggested by John Gardner <gardnerjohng at gmail dot com>.
2018-05-08Switch the emitted HTML element from <b> to <code> for the fixedIngo Schwarze
syntax element macros .Nm, .Fl, .Cm, .Ic, .In, .Fd, .Fn, and .Cd. Adjust both the internal and external style sheets such that rendering remains unchanged in typical browsers. Based on feedback from John Gardner <gardnerjohng at gmail dot com>.
2018-04-24replace my vague and idiosyncratic term "selflink"Ingo Schwarze
with the clearer and more usual "permalink"; suggested by John Gardner <gardnerjohng at gmail dot com>
2018-04-13preserve comments before .Dd and .TH (typically Copyright and license)Ingo Schwarze
in full HTML output, but not with -Ofragment, e.g. in man.cgi(8); suggested by Thomas Klausner <wiz at NetBSD>
2018-04-11preserve comments before .Dd when converting mdoc(7) to man(7)Ingo Schwarze
with mandoc -Tman; suggested by Thomas Klausner <wiz at NetBSD>
2017-07-15In .Bl -tag and -hang, do not print a margin-left style attributeIngo Schwarze
for each individual item if the -width argument matches the default of 6n. Suggested by Steffen Nurpmeso <steffen at sdaoden dot eu> on <groff at GNU dot org> in April 2017.
2017-07-15use the same width increase logic for .Bl -hang as for .Bl -tagIngo Schwarze
2017-07-14Handle .Bl -compact via CSS rather than writing individual styleIngo Schwarze
attributes into .It blocks; suggested by Steffen Nurpmeso <steffen at sdaoden dot eu> on <groff at GNU dot org> in April 2017. Delete margin-bottom and margin-top style names and the 'v' argument letter from print_otag() because they are no longer used.
2017-06-24Split -Wstyle into -Wstyle and the even lower -Wbase, and addIngo Schwarze
-Wopenbsd and -Wnetbsd to check conventions for the base system of a specific operating system. Mark operating system specific messages with "(OpenBSD)" at the end. Please use just "-Tlint" to check base system manuals (defaulting to -Wall, which is now -Wbase), but prefer "-Tlint -Wstyle" for the manuals of portable software projects you maintain that are not part of OpenBSD base, to avoid bogus recommendations about base system conventions that do not apply. Issue originally reported by semarie@, solution using an idea from tedu@, discussed with jmc@ and jca@.
2017-06-19Fix a regression in the previous revision:Ingo Schwarze
When there is no link description, reuse the URI. Reported by tj@ and bentley@.
2017-05-30fix formatting of intermediate punctuation in .LkIngo Schwarze
2017-05-17Delete pointless width calculation for SYNOPSIS .Nm block heads.Ingo Schwarze
Just let HTML <table> do its work of selecting the needed width. <Anton dot Lindqvist at gmail dot com> reported that the manually calculated width was insufficient in some manual pages.
2017-05-12Make the tag column in .Bl -tag lists wider:Ingo Schwarze
1. I forgot about the 2n padding between tag and body. 2. The factor 1.1 was too small for bold fold, make it *1.15 + 1n. Ugliness spotted by tb@.
2017-05-09Trailing \c suppresses the output line break even ifIngo Schwarze
the next line is a text line starting with whitespace. Quirk found in the sysutils/rancid port.
2017-05-05Move .sp to the roff modules. Enough infrastructure is in placeIngo Schwarze
now that this actually saves code: -70 LOC.
2017-05-05move .ll to the roff modulesIngo Schwarze
2017-05-05Move handling of the roff(7) .ft request from the man(7)Ingo Schwarze
modules to the new roff(7) modules. As a side effect, mdoc(7) now handles .ft, too. Of course, do not use that.
2017-05-04Start roff formatter modules for HTML and termininal output,Ingo Schwarze
used by both the mdoc and man formatters, with the ultimate goal of reducing code duplication between the two macro formatters. Made possible by the parser unification. Add the first formatting function (for the .br request).
2017-05-04Parser reorg:Ingo Schwarze
Generate the first node on the roff level: .br Fix some column numbers in diagnostic messages while here.
2017-04-24Continue parser unification:Ingo Schwarze
* Make enum rofft an internal interface as enum roff_tok in "roff.h". * Represent mdoc and man macros in enum roff_tok. * Make TOKEN_NONE a proper enum value and use it throughout. * Put the prologue macros first in the macro tables. * Unify mdoc_macroname[] and man_macroname[] into roff_name[].
2017-04-17Fix handling of trailing punctuation in .Lk.Ingo Schwarze
This macro is unusual in so far as trailing punction needs to remain inside the scope because it must be inside, not after the display of long URIs in terminal output mode. Improves formatting of fw_update(1), help(1), less(1), sendbug(1), acx(4), inet6(4), ipsec(4), oce(4), isakmpd.conf(5), afterboot(8), release(8), traceroute(8).
2017-03-17Fix regression in mdoc_html.c 1.150, man_html 1.87:Ingo Schwarze
For .Sh, .Ss, .SH, .SS, only write selflink if an id could be constructed. Crash reported by Raf Czlonka <rczlonka at gmail dot com>, analysis of root cause by natano@
2017-03-15Minimal support for deep linking into man(7) pages.Ingo Schwarze
As the man(7) language does not provide semantic markup, only .SH, .SS, and .UR become anchors for now.
2017-03-14Slightly increase widths calculated from string lengths (mainlyIngo Schwarze
for .Bl -tag lists and SYNOPSIS .Nm blocks), such that the text still fits even if it is printed in bold font. This is an ugly band aid - but implementing font-dependent width measurements would be a major project and even more difficult for HTML than for PostScript. Issue reported by Jan Stary <hans at stare dot cz>.
2017-03-13Port ctags-style, less(1) :t internal searching from terminal outputIngo Schwarze
to HTML output. For certain macros appearing at the beginning of .It heads, write HTML id="..." attributes such that deep linking works. Write HTML <a> attributes such that you can easily copy out link targets with the mouse. Try: http://man.openbsd.org/vmctl.8#create Feature suggested by <guettliml at Thomas dash Guettler dot de>, some details of the design and implementation by me.
2017-03-13Print title="..." in addition to id="..." attributes for macro keysIngo Schwarze
that can be searched for by apropos(1), such that you see the semantic function in a tooltip when hovering with the mouse.
2017-03-03remove a few redundant conditions that jsg@ found with cppcheckIngo Schwarze
2017-02-22Handle an odd edge case where .It is preceded by .Sm.Ingo Schwarze
NULL dereference in man.cgi reported by Gabriel Guzman <gabe at guzman dash nunez dot com> on misc@.
2017-02-16Remove the ENDBODY_NOSPACE flag, simplifying the code.Ingo Schwarze
Comparing to groff output, it appears that all cases where it was used and made a difference actually require the opposite, ENDBODY_SPACE. I have no idea why i added it back in 2010; maybe to compensate for some other bug that has long been fixed.
2017-02-06The .Nm macro does not only use the default name when it has noIngo Schwarze
argument, but also when the first argument is a child macro. Arcane issue found in the FreeBSD cxgbetool(8) manual that Baptiste Daroussin <bapt at FreeBSD> sent me long ago for a different reason. While solving this, switch to the new technique of doing text production in the validator, reducing code duplication in the formatters, which also makes -Ttree output clearer.
2017-02-05Wrap .St content in a <span class="St">.Ingo Schwarze
Also add forgotten <span class="Ux"> to .At rendering.
2017-02-05fix font selection for .Bf without argumentIngo Schwarze
2017-02-05mark up .Ar, .Fa, .Va, .Ft, and .Vt with <var> rather than <i>;Ingo Schwarze
suggested by bentley@ long ago, but needed lots of cleanup first
2017-02-05for .Rs, use <cite>Ingo Schwarze
2017-02-05Improve <table> syntax:Ingo Schwarze
The <col> element can only appear inside <colgroup>, so use <colgroup>. The <tbody> element is optional and useless, so don't use it. Even if we would ever need <thead> or <tfoot>, <tbody> would still be optional and useless; besides, we will likely never need <thead> or <tfoot>, simply because our languages don't support such functionality.
2017-01-29eliminate one useless struct and one level of indirection;Ingo Schwarze
no functional change
2017-01-28Simplify usage of print_otag() even more:Ingo Schwarze
accept NULL to skip the attribute or format.
2017-01-28.Bl -column with zero columns is legal, so don't segfalt on it.Ingo Schwarze
Bug introduced in rev. 1.123 triggered for example in gssapi(3), analyzed and reported by Michael <Stapelberg at debian dot org>. Simplify the code a bit more while here.
2017-01-25Improve HTML formatting of .Bl -tag.Ingo Schwarze
In particular, when using the style sheet, put the body on the same line as the head for short heads, or on the next line for long heads, in a way that preserves both correct indentation and correct vertical spacing with and without -compact, and with one or more heads per body (hi, Zaphod) - eight use cases so far - and with and without -tag, and with and without -offset, 32 use cases grand total. Using many ideas from zhuk@, from <David dot Dahlberg at fkie dot fraunhofer dot de>, and from Benny Lofgren <bl dash lists at lofgren dot biz>, and a few of my own. This is an excellent demonstration that CSS is an extremely hostile language, much more trapful and much harder to use than, say, C. When matthew@ reported this in July 2014 (!), it was already a known issue, and i no longer remember for how long. My first serious attempt at fixing it (in November 2015) failed miserably. I'd love to see simplifications of both the generated HTML code and of the style sheet, but without breaking any of the 32 use cases, please.
2017-01-21Avoid writing constant style attributes over and over again.Ingo Schwarze
Move them to the style sheet.
2017-01-21clean up the remaining class attributesIngo Schwarze
2017-01-20Standardize class attributes for semantic macros.Ingo Schwarze
Correct markup for .Va and iprove markup for .Dv, .Er, .Ev while here.
2017-01-20standardize .Rs class attributesIngo Schwarze
2017-01-20standardize .Bl and .It class attributesIngo Schwarze
2017-01-19clean up markup of .Bd, .D1, .Dl, .Li, and .Ql;Ingo Schwarze
in particular, stop abuse of <blockquote>
2017-01-19clean up .Sx and .Xr HTML markupIngo Schwarze
2017-01-19Clean up CSS rules for sections and paragraphs.Ingo Schwarze
Start using real macro names for CSS classes.
2017-01-19Start cleanup: trim useless HTML comments and <div> elementsIngo Schwarze
on the <html> and <body> levels.
2017-01-19Implement line breaking of the generated HTML code at space charactersIngo Schwarze
in filled text. This does not affect HTML semantics, but makes the HTML code even more humanly readable. While here, - collapse multiple consecutive space characters in filled text - and insert a blank between style entries.