sandbox/manpage-writer/expected-mandoc/references.man

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .
   4 .nr rst2man-indent-level 0
   5 .
   6 .de1 rstReportMargin
   7 \\$1 \\n[an-margin]
   8 level \\n[rst2man-indent-level]
   9 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  10 -
  11 \\n[rst2man-indent0]
  12 \\n[rst2man-indent1]
  13 \\n[rst2man-indent2]
  14 ..
  15 .de1 INDENT
  16 .\" .rstReportMargin pre:
  17 . RS \\$1
  18 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  19 . nr rst2man-indent-level +1
  20 .\" .rstReportMargin post:
  21 ..
  22 .de UNINDENT
  23 . RE
  24 .\" indent \\n[an-margin]
  25 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  26 .nr rst2man-indent-level -1
  27 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  29 ..
  30 .TH "REFERENCE TESTS"  "" ""
  31 .SH NAME
  32 reference tests \-
  33 .SH HOW TO MARKUP
  34 .sp
  35 link adr in .UR .UE or simply in parantheses
  36 .INDENT 0.0
  37 .IP \(bu 2
  38 man and mandoc convert UR/UE to \fB<\fP and \fB>\fP\&.
  39 .IP \(bu 2
  40 pandoc transforms
  41 .INDENT 2.0
  42 .INDENT 3.5
  43 .sp
  44 .EX
  45 See the \(gaPython home page <https://www.python.org>\(ga_ for info.
  46 .EE
  47 .UNINDENT
  48 .UNINDENT
  49 .sp
  50 to
  51 .INDENT 2.0
  52 .INDENT 3.5
  53 .sp
  54 .EX
  55 see See the Python home page (https://www.python.org) for info.
  56 .EE
  57 .UNINDENT
  58 .UNINDENT
  59 .UNINDENT
  60 .SH TEST FOR REFERENCES IN MAN PAGES
  61 .sp
  62 embedded in a paragraph
  63 .INDENT 0.0
  64 .IP \(bu 2
  65 at line start
  66 .IP \(bu 2
  67 in line
  68 .IP \(bu 2
  69 at eol
  70 .UNINDENT
  71 .sp
  72 at start of paragraph
  73 .INDENT 0.0
  74 .IP \(bu 2
  75 followed by text
  76 .IP \(bu 2
  77 at eol
  78 .UNINDENT
  79 .sp
  80 at end of paragraph
  81 .SH TESTS
  82 .sp
  83 See
  84 .UR https://docutils.sourceforge.io/docs/user/rst/quickref.html#explicit\-markup
  85 .UE
  86
  87 for more
  88 .sp
  89 See the
  90 .UR https://www.python.org
  91 Python home page
  92 .UE
  93  for info.
  94 .sp
  95 External hyperlinks, like
  96 .UR https://www.python.org
  97 Python
  98 .UE
  99 \&.
 100 .sp
 101 Want to learn about
 102 .UR https://www.python.org
 103 my favorite programming language
 104 .UE
 105 ?
 106 .sp
 107 Clicking on this internal hyperlink will take us to the
 108 .UR target
 109 .UE
 110
 111 below.
 112 .sp
 113 The hyperlink target above points to this paragraph.
 114 .INDENT 0.0
 115 .IP \(bu 2
 116 bullet list
 117 .IP \(bu 2
 118 second item, with hyperlink target.
 119 .UNINDENT
 120 .sp
 121 See the
 122 .UR https://www.python.org
 123 Python
 124 .UE
 125  home page for info.
 126 .sp
 127 .UR mailto:jdoe@example.com
 128 Write to me
 129 .UE
 130  with your questions.
 131 .sp
 132 The
 133 .UR https://docutils.sourceforge.io/rst.html
 134 one\-liner
 135 .UE
 136  and
 137 .UR https://docutils.sourceforge.net/rst.html
 138 starts\-on\-this\-line
 139 .UE
 140  or
 141 .UR https://docutils.sourceforge.net/rst.html
 142 entirely\-below
 143 .UE
 144  point to
 145 .UR https://docutils.sourceforge.io/rst.html
 146 .UE
 147  and in man are ... ?
 148 .sp
 149 Escaped whitespace is preserved as intentional spaces, e.g.:
 150 .sp
 151 some
 152 .UR ../local path with spaces.html
 153 reference
 154 .UE
 155  to a local path.
 156 .sp
 157 Anonymous hyperlink references are specified with two underscores instead of one:
 158 .sp
 159 See
 160 .UR https://www.python.org
 161 the web site of my favorite programming language
 162 .UE
 163 \&.
 164 .sp
 165 Anonymous targets begin with \(dq.. __:\(dq; no reference name is required or allowed:
 166 .\" Generated by docutils manpage writer.
 167 .