All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Thaddeus H. Black" <thb@debian.org>
To: Alejandro Colomar <alx.manpages@gmail.com>
Cc: "G . Branden Robinson" <g.branden.robinson@gmail.com>,
	Michael Kerrisk <mtk.manpages@gmail.com>,
	linux-man@vger.kernel.org
Subject: Re: [PATCH 3/3] Use subsections instead of sections
Date: Sun, 12 Sep 2021 14:20:33 +0000	[thread overview]
Message-ID: <YT4MsXe46WlMa8i0@b-tk.org> (raw)
In-Reply-To: <20210909072442.423117-4-alx.manpages@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 2600 bytes --]

Alejandro:

I have applied all your patches but have one question.  Consider the
following sample manual page, which uses the .TP subsubsectioning technique
you have recommended.  In the sample, observe the difference between
subsubsections 1a and 1b.

    FOO(7)                 Linux Programmer's Manual                 FOO(7)

    NAME
           foo - sample to illustrate manual-page markup

    DESCRIPTION
           Lorem ipsum dolor sit amet, consectetur adipiscing elit.

       Subsection 1
           Sed at ante.

           Subsubsection 1a
                  Mauris  eleifend,  quam  a  vulputate  dictum, massa quam
                  dapibus leo, eget vulputate  orci  purus  ut  lorem.   In
                  fringilla mi in ligula.

           Sss 1b Pellentesque  aliquam  quam  vel dolor.  Nunc adipiscing.
                  Sed quam odio, tempus ac, aliquam  molestie,  varius  ac,
                  tellus.

           Subsubsection 1c
                  Vestibulum  ut nulla aliquam risus rutrum interdum.  Pel‐
                  lentesque lorem.  Curabitur sit amet erat quis risus feu‐
                  giat viverra.

       Subsection 2
           Pellentesque augue justo, sagittis et, lacinia at.

    CONFORMING TO
           Example.

    Linux                          1970-01-01                        FOO(7)

Groff has typeset subsubsection 1a as you like it, but has typeset
subsubsection 1b, which has a shorter title, differently.  This is okay
with me, but is it okay with you?

[No such short title occurs in filename(7), but such a short title might
occur in another, future manual page that emulated the technique.  This
is why I ask.]

Sample source follows.

---------------------------------------------------------------------------
.TH FOO 7 1970-01-01 "Linux" "Linux Programmer's Manual"
.SH NAME
foo \- sample to illustrate manual-page markup
.SH DESCRIPTION
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
.SS Subsection 1
Sed at ante.
.TP
.B Subsubsection 1a
Mauris eleifend, quam a vulputate dictum,
massa quam dapibus leo,
eget vulputate orci purus ut lorem.
In fringilla mi in ligula.
.TP
.B Sss 1b
Pellentesque aliquam quam vel dolor.
Nunc adipiscing.
Sed quam odio, tempus ac, aliquam molestie, varius ac, tellus.
.TP
.B Subsubsection 1c
Vestibulum ut nulla aliquam risus rutrum interdum.
Pellentesque lorem.
Curabitur sit amet erat quis risus feugiat viverra.
.SS Subsection 2
Pellentesque augue justo, sagittis et, lacinia at.
.SH CONFORMING TO
Example.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  parent reply	other threads:[~2021-09-12 14:20 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-06 11:40 [PATCH] filename.7: new manual page Thaddeus H. Black
2021-09-06 14:21 ` Alejandro Colomar (man-pages)
2021-09-06 16:59   ` G. Branden Robinson
2021-09-06 21:47     ` Alejandro Colomar (man-pages)
2021-09-08  3:54       ` G. Branden Robinson
2021-09-08 14:56   ` Thaddeus H. Black
2021-09-08 15:45     ` Alejandro Colomar (man-pages)
2021-09-09  2:15       ` Thaddeus H. Black
2021-09-09  2:45         ` Thaddeus H. Black
2021-09-09  7:24         ` [PATCH 1/3] Remove unnecessary .P after .S[HS] Alejandro Colomar
2021-09-09  7:24         ` [PATCH 2/3] Fix indentation of paragraph, which continues talking about \0 Alejandro Colomar
2021-09-09  7:24         ` [PATCH 3/3] Use subsections instead of sections Alejandro Colomar
2021-09-09  7:28           ` [PATCH] .P -> .PP Alejandro Colomar
2021-09-12 14:20           ` Thaddeus H. Black [this message]
2021-09-12 14:49             ` [PATCH 3/3] Use subsections instead of sections Alejandro Colomar (man-pages)
2021-09-12 14:56               ` Alejandro Colomar (man-pages)
2021-09-12 15:22                 ` Thaddeus H. Black
2021-09-12 18:49                   ` G. Branden Robinson
2021-09-12 18:12                 ` G. Branden Robinson
2021-09-12 22:39                   ` Alejandro Colomar (man-pages)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YT4MsXe46WlMa8i0@b-tk.org \
    --to=thb@debian.org \
    --cc=alx.manpages@gmail.com \
    --cc=g.branden.robinson@gmail.com \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.