groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 41/51: groff_mdoc(7): Ditch the table of contents.


From: G. Branden Robinson
Subject: [groff] 41/51: groff_mdoc(7): Ditch the table of contents.
Date: Sun, 11 Sep 2022 08:15:55 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 532554378053fb0d4c90d2240a5ae40759a95001
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Sep 8 04:25:41 2022 -0500

    groff_mdoc(7): Ditch the table of contents.
    
    (1) No other man page we ship presents such a thing; (2) no man page
    should be so lengthy or elaborate that one is required; (3) coding one
    this way presents obvious DRY problems; and (4) when rendering man(7)
    and mdoc(7) to PDF with groff, you get hierarchical navigation links
    that correspond to section and subsection headings anyway, a superior
    solution to the problem of navigability.
    
    Also ditch the "troff idiosyncrasies" section heading.  It isn't
    accurate; what follows is an introduction to roff language syntax, not
    its "idiosycrasies".
---
 tmac/groff_mdoc.7.man | 130 --------------------------------------------------
 1 file changed, 130 deletions(-)

diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index dfe5670a0..e9a05bfec 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -131,136 +131,6 @@ and irrespective of the macro package selected for its 
composition.
 .
 .Sh "Getting started"
 .
-The material presented in the remainder of this document is outlined
-as follows:
-.
-.Bl -enum -width 3n -offset indent
-.  It
-.  Tn "troff idiosyncrasies"
-.
-.  Bl -tag -width 2n -compact
-.    It "Macro Usage"
-.    It "Passing Space Characters in an Argument"
-.    It "Trailing Blank Space Characters"
-.    It "Escaping Special Characters"
-.    It "Other Possible Pitfalls"
-.  El
-.
-.  It
-.  Tn "A manual page template"
-.
-.  It
-.  Tn "Conventions"
-.
-.  It
-.  Tn "Title macros"
-.
-.  It
-.  Tn "Introduction of manual and general text domains"
-.
-.  Bl -tag -width 2n -compact
-.    It "What's in a Name" Ns ...
-.    It "General Syntax"
-.  El
-.
-.  It
-.  Tn "Manual domain"
-.
-.  Bl -tag -width 2n -compact
-.    It "Addresses"
-.    It "Author Name"
-.    It "Arguments"
-.    It "Configuration Declarations (Section Four Only)"
-.    It "Command Modifiers"
-.    It "Defined Variables"
-.    It "Errnos"
-.    It "Environment Variables"
-.    It "Flags"
-.    It "Function Declarations"
-.    It "Function Types"
-.    It "Functions (Library Routines)"
-.    It "Function Arguments"
-.    It "Return Values"
-.    It "Exit Status"
-.    \" .It "Header File (including source code)"
-.    It "Interactive Commands"
-.    It "Library Names"
-.    It "Literals"
-.    It "Names"
-.    It "Options"
-.    It "Pathnames"
-.    It "Standards"
-.    It "Variable Types"
-.    It "Variables"
-.    It "Manual Page Cross References"
-.  El
-.
-.  It
-.  Tn "General text domain"
-.
-.  Bl -tag -width 2n -compact
-.    It "AT&T Macro"
-.    It "BSD Macro"
-.    It "NetBSD Macro"
-.    It "FreeBSD Macro"
-.    It "DragonFly Macro"
-.    It "OpenBSD Macro"
-.    It "BSD/OS Macro"
-.    It "Unix Macro"
-.    It "Emphasis Macro"
-.    It "Font Mode"
-.    It "Enclosure and Quoting Macros"
-.    It "No-Op or Normal Text Macro"
-.    It "No-Space Macro"
-.    It "Section Cross References"
-.    It "Symbolics"
-.    It "Mathematical Symbols"
-.    It "References and Citations"
-.    It "Trade Names (or Acronyms and Type Names)"
-.    It "Extended Arguments"
-.  El
-.
-.  It
-.  Tn "Page structure domain"
-.
-.  Bl -tag -width 2n -compact
-.    It "Section Headers"
-.    It "Subsection Headers"
-.    It "Paragraphs and Line Spacing"
-.    It "Keeps"
-.    It "Examples and Displays"
-.    It "Lists and Columns"
-.  El
-.
-.  It
-.  Tn "Miscellaneous macros"
-.
-.  It
-.  Tn "Predefined strings"
-.
-.  It
-.  Tn "Diagnostics"
-.
-.  It
-.  Tn "Formatting with groff, troff, and nroff"
-.
-.  It
-.  Tn "Files"
-.
-.  It
-.  Tn "See also"
-.
-.  It
-.  Tn "Bugs"
-.El
-.
-.\" XXX
-.if t \
-.  ne 7
-.
-.
-.Sh "troff idiosyncrasies"
-.
 The
 .Nm mdoc
 package attempts to simplify the process of writing a man page.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]