diff options
author | John Ankarström <john@ankarstrom.se> | 2021-06-18 16:17:12 +0200 |
---|---|---|
committer | John Ankarström <john@ankarstrom.se> | 2021-06-18 16:17:12 +0200 |
commit | 427bb11eeffae931bec991b338aefeaa7ff1de76 (patch) | |
tree | 0c4f0def16e5de574b71833906eadeaf76e14a48 /example.t | |
parent | 9365fec1a278974b4cabc9192f0797fc5d1d1682 (diff) | |
download | mk-427bb11eeffae931bec991b338aefeaa7ff1de76.tar.gz |
Organize and document source code
Diffstat (limited to 'example.t')
-rw-r--r-- | example.t | 28 |
1 files changed, 20 insertions, 8 deletions
@@ -13,14 +13,16 @@ Introduction .i Mg is a simple macro package for troff with the following features: .p -1. It is designed to be easy to understand and to customize +1. \c +It is designed to be easy to understand and to customize by editing the source code. .p -2. It makes use of the extended support for environments -offered by many modern troff implementations -(but it can be made compatible with the original troff if need be). +2. \c +It makes use of the extended support for environments +offered by many modern troff implementations. .p -3. It is designed to be practically easy to use. +3. \c +It is designed to be practically easy to use. Macros are consistently one letter long and written in lowercase. .p While @@ -53,7 +55,7 @@ If the user wishes to modify the default font size, he or she can simply switch to the .i p environment and set the font size as desired: -.c +.l .eo .cc , .\" set heading font @@ -76,7 +78,7 @@ are applied to all environments. It is thus remarkably simple and intuitive to set, for example, the default font of a document: -.c +.l .cc , .fam N .t @@ -85,4 +87,14 @@ Document title First paragraph. ,cc .p -\&... +In addition to the normal environment-relevant settings, +.i mg +manually associates a few special registers with the current environment: +.p +1. \c +.c sp , +the amount of vertical space to add before environment. +.p +2. \c +.c ti , +the indentation of the first line in the environment. |