Restructure headlines in ox-groff.org
authorSuvayu Ali <fatkasuvayu+linux@gmail.com>
Sat, 30 Mar 2013 14:24:47 +0000 (15:24 +0100)
committerSuvayu Ali <fatkasuvayu+linux@gmail.com>
Sat, 30 Mar 2013 23:53:33 +0000 (00:53 +0100)
exporters/ox-groff.org

index 77eafd1..96a5e46 100644 (file)
@@ -1,4 +1,10 @@
-** Groff and PDF export
+#+TITLE: Groff and PDF export
+#+AUTHOR: Luis Anaya
+#+DATE: 2012-08-10
+#+OPTIONS: H:2 toc:t num:nil
+#+STARTUP: folded
+#+CATEGORY: worg
+
 Org mode provides the ability to export files marked with the Groff
 Memorandum Macros (-mm) set. With additional processing it can turn
 these files into PDF files that can be used for general
@@ -10,11 +16,11 @@ Groff is commonly installed because it is needed for the generation of
 The Groff export follows the sequence of macro calls needed for the
 Memorandum Type covers.
 
-*** To use this feature
+* To use this feature
 Include =(require 'org-e-groff)= in your =.emacs= file. This feature
 only works with the new =ox= facility.
 
-*** Groff MM macro summary
+* Groff MM macro summary
 For the purpose of context, the following list describes some of the
 macros used during export. These are built from data stored by your org
 document and follows the order needed for the generation of cover
@@ -38,16 +44,16 @@ In such order:
         Groff supports the use of the different Memorandum Types as well
         as Cover Pages (COVER/COVEND pairs).
 
-*** Groff export commands
 - M-x org-groff-export-to-groff :: Converts buffer to Groff under
-       the assumptions that it was Org mode syntax. For an Org file like
-       =myfile.org= the Groff file will be =myfile.groff=. The file will
-       be overwritten without warning.
 - M-x org-groff-export-to-pdf :: Converts buffer to a PDF file under
-       the assumptions that it was Org mode syntax. It uses Groff as its
-       typesetter engine.
+* Groff export commands
+ - M-x org-groff-export-to-groff :: Converts buffer to Groff under
+      the assumptions that it was Org mode syntax. For an Org file like
+      =myfile.org= the Groff file will be =myfile.groff=. The file will
+      be overwritten without warning.
+ - M-x org-groff-export-to-pdf :: Converts buffer to a PDF file under
+      the assumptions that it was Org mode syntax. It uses Groff as its
+      typesetter engine.
 
-*** Header and sectioning structure
+* Header and sectioning structure
 By default, the Groff export uses the =internal= (.MT 0) Memorandum Type
 to generate documents.
 
@@ -166,7 +172,7 @@ gets exported.  The following options are supported:
                   used to populate the reference. /(boolean)/
 - :attention :: Adds an "ATTENTION:" line. /(string)/
 
-*** Special Tags
+* Special Tags
 The Groff exporter now features a set of tags that handles special
 contents required for the inclusion of abstracts sections, and parts of
 a business letter. The following special tags are in use by the
@@ -186,7 +192,7 @@ Special tags have several rules to follow. These are:
      the document.
 The use of these is described in detail in the following sections.
 
-**** Tags used for Letter types.
+** Tags used for Letter types.
 Letter types use the FROM, TO, BODY and NS tags for placing content in
 a document class of letter.  Letter types are the ones defined as:
 block, semiblock, simplified and fullblock.
@@ -222,7 +228,7 @@ Illustrated below is how a typical letter looks like:
         In the exaple, it will write "Copy to" Jill Brown at
         the end of the letter.
 
-**** Tags used for Memorandum Types letters
+** Tags used for Memorandum Types letters
 Letters that are of type "memo" also use the FROM, TO, BODY and NS tags
 for placing content in a document class of letter.
 Memo letter types are the ones defined as: "letter" or a custom cover.
@@ -271,7 +277,7 @@ written. Although MT 5 is the "letter" memorandum type, Groff does not
 follow the same convention as Bell Labs' troff. Therefore, the use
 of these document classes is usable only to custom type covers.
 
-**** Tags used for Memorandum Types documents.
+** Tags used for Memorandum Types documents.
 Documents that are of type "memo" use the FROM and ABSTRACT
 for placing content in a document class of memo
 Letter types are the ones defined as: internal, external, file,
@@ -338,7 +344,7 @@ Email Address
 Out of all these values, the only one required is the initials. The
 others do not need to be written and they will not be written in the document.
 
-*** Tables in Groff export
+* Tables in Groff export
 Groff uses the =tbl= preprocessor for table exports but the Groff export
 process also supports the specification of labels, captions and table
 options with the use of the =#+ATTR_GROFF:= line. The following options
@@ -363,7 +369,7 @@ are available to modify table behavior.
 The Groff export will honor columns definitions placed on top of a given
 table in Org mode and propagates those definitions as =tbl= commands.
 
-*** Images in Groff export
+* Images in Groff export
 Groff provides very limited support for image export and this limitation
 is reflected in the export. The Groff export uses the =pic= preprocessor
 and the -Tps device for image support. The only types that are supported
@@ -396,7 +402,7 @@ The following options are available:
 - :heigth :: Defines the hight of the image in Groff units. For
              example :heigth 1.0i or :height 2.0c.  /(symbol)/
 
-*** Footnotes and References
+* Footnotes and References
 The Groff export uses the same footnote mechanism to identify footnotes
 and bibliographic references. Adding a =\[1\]= or a =\[fn:123\]= marker with its
 appropriate reference will create a footnote at the end of the page.
@@ -415,7 +421,7 @@ of Contents.
 Footnotes markers with the same tag will refer to the same reference in
 the list.
 
-*** Special Characters
+* Special Characters
 Special character substitution can be enabled if there is a list
 specified in the =org-groff-special-char= variable. This variable
 consists of a list of cons pairs in which the first value is the item to
@@ -425,7 +431,7 @@ and (rg) for registered mark.
 
 Character substitution can be disabled by setting this variable to *nil*.
 
-*** Source highlight in Groff export
+* Source highlight in Groff export
 There are no packages or processors for syntax highlight in
 Groff. However this feature is available for Groff export with the use
 of GNU's source highlight
@@ -528,7 +534,7 @@ available in source highlight. An example  of an entry is:
 If a language is not defined, then the Groff export process will default
 to write the code in Constant Width font.
 
-*** Embedded Groff
+* Embedded Groff
 Groff commands can be exported literally by surrounding the text on a
 pair of #+BEGIN_GROFF/#+END_GROFF lines.  These are a couple of
 commands that can be useful during export to control the output.
@@ -570,7 +576,7 @@ Used with the dummy document class, it can be used to add an abstract block to
 any of the memorandum type. The internal type is presented for
 reference. Absract text must be placed betwen .AS and .AE.
 
-*** Known Limitations
+* Known Limitations
 The following limitations are known at the time of release. They will be
 looked at and addressed  in subsequent releases if they are technically
 solvable.