aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-11-09 05:11:46 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-11-09 05:11:46 +0000
commit060f8931727b8f4df33482e8d157392a16cf6c65 (patch)
treef7ab95b8f8aeb6531f922efa2331a5399b17653f
parentd9e67de8a307ad4987bf67f964a22e475e56644e (diff)
downloadmandoc-060f8931727b8f4df33482e8d157392a16cf6c65.tar.gz
mandoc-060f8931727b8f4df33482e8d157392a16cf6c65.tar.zst
mandoc-060f8931727b8f4df33482e8d157392a16cf6c65.zip
Documented \s and cleaned up \f documentation in mdoc.7, man.7.
-Thtml now using a2roffdeco().
-rw-r--r--html.c143
-rw-r--r--man.733
-rw-r--r--mdoc.737
3 files changed, 96 insertions, 117 deletions
diff --git a/html.c b/html.c
index ee90cda1..b2fc6064 100644
--- a/html.c
+++ b/html.c
@@ -1,4 +1,4 @@
-/* $Id: html.c,v 1.81 2009/11/05 10:16:01 kristaps Exp $ */
+/* $Id: html.c,v 1.82 2009/11/09 05:11:46 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
@@ -66,7 +66,7 @@ static const struct htmldata htmltags[TAG_MAX] = {
{"base", HTML_CLRLINE | HTML_NOSTACK}, /* TAG_BASE */
};
-static const char *const htmlattrs[ATTR_MAX] = {
+static const char *const htmlattrs[ATTR_MAX] = {
"http-equiv",
"content",
"name",
@@ -87,6 +87,13 @@ static const char *const htmlattrs[ATTR_MAX] = {
extern int getsubopt(char **, char * const *, char **);
#endif
+
+static void print_spec(struct html *, const char *, int);
+static void print_res(struct html *, const char *, int);
+static void print_ctag(struct html *, enum htmltag);
+static void print_encode(struct html *, const char *);
+
+
void *
html_alloc(char *outopts)
{
@@ -214,107 +221,12 @@ print_res(struct html *h, const char *p, int len)
static void
-print_escape(struct html *h, const char **p)
-{
- int j, type;
- const char *wp;
-
- wp = *p;
- type = 1;
-
- if (0 == *(++wp)) {
- *p = wp;
- return;
- }
-
- if ('(' == *wp) {
- wp++;
- if (0 == *wp || 0 == *(wp + 1)) {
- *p = 0 == *wp ? wp : wp + 1;
- return;
- }
-
- print_spec(h, wp, 2);
- *p = ++wp;
- return;
-
- } else if ('*' == *wp) {
- if (0 == *(++wp)) {
- *p = wp;
- return;
- }
-
- switch (*wp) {
- case ('('):
- wp++;
- if (0 == *wp || 0 == *(wp + 1)) {
- *p = 0 == *wp ? wp : wp + 1;
- return;
- }
-
- print_res(h, wp, 2);
- *p = ++wp;
- return;
- case ('['):
- type = 0;
- break;
- default:
- print_res(h, wp, 1);
- *p = wp;
- return;
- }
-
- } else if ('f' == *wp) {
- if (0 == *(++wp)) {
- *p = wp;
- return;
- }
-
- /*
- * These aren't supported, as they're symmetry-breaking
- * constructs that don't play well with hierarchical
- * mark-up. Consider:
- *
- * \fBHello.
- * .PP
- * World.
- *
- * The style started before "Hello" wouldn't be able to
- * propogate into the next `PP' because we'd exit the
- * current paragraph's scope.
- */
-
- *p = wp;
- return;
-
- } else if ('[' != *wp) {
- print_spec(h, wp, 1);
- *p = wp;
- return;
- }
-
- wp++;
- for (j = 0; *wp && ']' != *wp; wp++, j++)
- /* Loop... */ ;
-
- if (0 == *wp) {
- *p = wp;
- return;
- }
-
- if (type)
- print_spec(h, wp - j, j);
- else
- print_res(h, wp - j, j);
-
- *p = wp;
-}
-
-
-static void
print_encode(struct html *h, const char *p)
{
size_t sz;
+ int len;
+ const char *seq;
+ enum roffdeco deco;
for (; *p; p++) {
sz = strcspn(p, "\\<>&");
@@ -323,18 +235,33 @@ print_encode(struct html *h, const char *p)
p += /* LINTED */
sz;
- if ('\\' == *p) {
- print_escape(h, &p);
+ if ('<' == *p) {
+ printf("&lt;");
+ continue;
+ } else if ('>' == *p) {
+ printf("&gt;");
+ continue;
+ } else if ('&' == *p) {
+ printf("&amp;");
continue;
} else if ('\0' == *p)
break;
- if ('<' == *p)
- printf("&lt;");
- else if ('>' == *p)
- printf("&gt;");
- else if ('&' == *p)
- printf("&amp;");
+ seq = ++p;
+ len = a2roffdeco(&deco, &seq, &sz);
+
+ switch (deco) {
+ case (DECO_RESERVED):
+ print_res(h, seq, sz);
+ break;
+ case (DECO_SPECIAL):
+ print_spec(h, seq, sz);
+ break;
+ default:
+ break;
+ }
+
+ p += len - 1;
}
}
diff --git a/man.7 b/man.7
index a7387f9c..92d0fc59 100644
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\" $Id: man.7,v 1.47 2009/11/05 08:40:16 kristaps Exp $
+.\" $Id: man.7,v 1.48 2009/11/09 05:11:46 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: November 5 2009 $
+.Dd $Mdocdate: November 9 2009 $
.Dt MAN 7
.Os
.
@@ -110,8 +110,33 @@ and
Terms may be text-decorated using the
.Sq \ef
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P
-(revert to previous mode). A numerical representation 3, 2, or 1
-(bold, italic, and Roman, respectively) may be used instead.
+(revert to previous mode):
+.Pp
+.D1 \efBbold\efR \efIitalic\efP
+.Pp
+A numerical representation 3, 2, or 1 (bold, italic, and Roman,
+respectively) may be used instead.
+.Pp
+Text may also be sized with the
+.Sq \es
+escape, whose syntax is one of
+.Sq \es+-n
+for one-digit numerals;
+.Sq \es(+-nn
+or
+.Sq \es+-(nn
+for two-digit numerals; and
+.Sq \es[+-N] ,
+.Sq \es+-[N] ,
+.Sq \es'+-N' ,
+or
+.Sq \es+-'N'
+for arbitrary-digit numerals:
+.Pp
+.D1 \es+1bigger\es-1
+.D1 \es[+10]much bigger\es[-10]
+.D1 \es+(10much bigger\es-(10
+.D1 \es+'100'much much bigger\es-'100'
.
.
.Ss Whitespace
diff --git a/mdoc.7 b/mdoc.7
index 481d6f06..3a58b271 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.75 2009/11/06 10:31:31 kristaps Exp $
+.\" $Id: mdoc.7,v 1.76 2009/11/09 05:11:46 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: November 6 2009 $
+.Dd $Mdocdate: November 9 2009 $
.Dt MDOC 7
.Os
.
@@ -132,10 +132,37 @@ and
Terms may be text-decorated using the
.Sq \ef
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P
-(revert to previous mode). A numerical representation 3, 2, or 1
-(bold, italic, and Roman, respectively) may be used instead.
+(revert to previous mode):
.Pp
-These form is not recommended for
+.D1 \efBbold\efR \efIitalic\efP
+.Pp
+A numerical representation 3, 2, or 1 (bold, italic, and Roman,
+respectively) may be used instead.
+.Pp
+Text may also be sized with the
+.Sq \es
+escape, whose syntax is one of
+.Sq \es+-n
+for one-digit numerals;
+.Sq \es(+-nn
+or
+.Sq \es+-(nn
+for two-digit numerals; and
+.Sq \es[+-N] ,
+.Sq \es+-[N] ,
+.Sq \es'+-N' ,
+or
+.Sq \es+-'N'
+for arbitrary-digit numerals:
+.Pp
+.D1 \es+1bigger\es-1
+.D1 \es[+10]much bigger\es[-10]
+.D1 \es+(10much bigger\es-(10
+.D1 \es+'100'much much bigger\es-'100'
+.Pp
+Note these forms are
+.Em not
+recommended for
.Nm ,
which encourages semantic annotation.
.