e10d5b3 · typeable/pandoc

git.iko.soy/typeable/pandoc

Change 'groff' -> 'roff'.

These formats (man, ms) are not groff-specific.

commite10d5b3d5bc4de124549762b1523575c7824ca28 authorJohn MacFarlane <jgm@berkeley.edu> dateThu 1 Nov 2018, 16:46 (8 years ago) parent26341c1

7 files changed+22−22

compare with master

unifiedsplit

MANUAL.txt+8−8 pandoc.cabal+2−2 src/Text/Pandoc/Pretty.hs+1−1 src/Text/Pandoc/Readers/Roff.hs+2−2 src/Text/Pandoc/Writers/Man.hs+3−3 src/Text/Pandoc/Writers/Ms.hs+4−4 src/Text/Pandoc/Writers/Roff.hs+2−2

MANUAL.txt+8−8

@@ -285,13 +285,13 @@ General options {.options}

285285 - `jats` ([JATS] XML)

286286 - `json` (JSON version of native AST)

287287 - `latex` ([LaTeX])

288− - `man` ([groff man])

288+ - `man` ([roff man])

289289 - `markdown` ([Pandoc's Markdown])

290290 - `markdown_mmd` ([MultiMarkdown])

291291 - `markdown_phpextra` ([PHP Markdown Extra])

292292 - `markdown_strict` (original unextended [Markdown])

293293 - `mediawiki` ([MediaWiki markup])

294− - `ms` ([groff ms])

294+ - `ms` ([roff ms])

295295 - `muse` ([Muse]),

296296 - `native` (native Haskell),

297297 - `odt` ([OpenOffice text document][ODT])

@@ -442,8 +442,8 @@ General options {.options}

442442[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax

443443[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html

444444[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0

445−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html

446−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html

445+[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html

446+[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html

447447[Haskell]: https://www.haskell.org

448448[GNU Texinfo]: http://www.gnu.org/software/texinfo/

449449[Emacs Org mode]: http://orgmode.org

@@ -861,9 +861,9 @@ Options affecting specific writers {.options}

861861: Use only ASCII characters in output. Currently supported for

862862 XML and HTML formats (which use entities instead of

863863 UTF-8 when this option is selected), Markdown (which uses

864− entities), groff ms (which use hexadecimal escapes), and to

864+ entities), roff ms (which use hexadecimal escapes), and to

865865 a limited degree LaTeX (which uses standard commands for

866− accented characters when possible). Groff man output uses

866+ accented characters when possible). roff man output uses

867867 ASCII by default.

868868

869869`--reference-links`

@@ -3334,7 +3334,7 @@ AsciiDoc

33343334Texinfo

33353335 ~ It will be rendered inside a `@math` command.

33363336

3337−groff man

3337+roff man

33383338 ~ It will be rendered verbatim without `$`'s.

33393339

33403340MediaWiki, DokuWiki

@@ -3474,7 +3474,7 @@ Emacs Org mode, and ConTeXt.

34743474Inline spans and fenced code blocks with a special

34753475kind of attribute will be parsed as raw content with the

34763476designated format. For example, the following produces a raw

3477−groff `ms` block:

3477+roff `ms` block:

34783478

34793479 ```{=ms}

34803480 .MYMACRO

pandoc.cabal+2−2

@@ -20,12 +20,12 @@ description: Pandoc is a Haskell library for converting from one markup

2020 (subsets of) HTML, reStructuredText, LaTeX, DocBook, JATS,

2121 MediaWiki markup, TWiki markup, TikiWiki markup, Creole 1.0,

2222 Haddock markup, OPML, Emacs Org-Mode, Emacs Muse, txt2tags,

23− Vimwiki, Word Docx, ODT, EPUB, FictionBook2, groff man,

23+ Vimwiki, Word Docx, ODT, EPUB, FictionBook2, roff man,

2424 and Textile, and it can write Markdown, reStructuredText,

2525 XHTML, HTML 5, LaTeX, ConTeXt, DocBook, JATS, OPML, TEI,

2626 OpenDocument, ODT, Word docx, PowerPoint pptx,

2727 RTF, MediaWiki, DokuWiki, ZimWiki, Textile,

28− groff man, groff ms, plain text, Emacs Org-Mode,

28+ roff man, roff ms, plain text, Emacs Org-Mode,

2929 AsciiDoc, Haddock markup, EPUB (v2 and v3),

3030 FictionBook2, InDesign ICML, Muse, LaTeX beamer slides,

3131 and several kinds of HTML/JavaScript slide shows

src/Text/Pandoc/Pretty.hs+1−1

@@ -432,7 +432,7 @@ nowrap doc = Doc $ mapWithIndex replaceSpace $ unDoc doc

432432 replaceSpace _ x = x

433433

434434-- | Content to print only if it comes at the beginning of a line,

435−-- to be used e.g. for escaping line-initial `.` in groff man.

435+-- to be used e.g. for escaping line-initial `.` in roff man.

436436afterBreak :: String -> Doc

437437afterBreak s = Doc $ singleton (AfterBreak s)

438438

src/Text/Pandoc/Readers/Roff.hs+2−2

@@ -29,7 +29,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

2929 Stability : WIP

3030 Portability : portable

3131

32−Tokenizer for groff formats (man, ms).

32+Tokenizer for roff formats (man, ms).

3333-}

3434module Text.Pandoc.Readers.Roff

3535 ( FontSpec(..)

@@ -705,7 +705,7 @@ linePartsToString = mconcat . map go

705705 go (RoffStr s) = s

706706 go _ = mempty

707707

708−-- | Tokenize a string as a sequence of groff tokens.

708+-- | Tokenize a string as a sequence of roff tokens.

709709lexRoff :: PandocMonad m => SourcePos -> T.Text -> m RoffTokens

710710lexRoff pos txt = do

711711 eithertokens <- readWithM (do setPosition pos

src/Text/Pandoc/Writers/Man.hs+3−3

@@ -27,7 +27,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

2727 Stability : alpha

2828 Portability : portable

2929

30−Conversion of 'Pandoc' documents to groff man page format.

30+Conversion of 'Pandoc' documents to roff man page format.

3131

3232-}

3333module Text.Pandoc.Writers.Man ( writeMan) where

@@ -55,7 +55,7 @@ writeMan :: PandocMonad m => WriterOptions -> Pandoc -> m Text

5555writeMan opts document =

5656 evalStateT (pandocToMan opts document) defaultWriterState

5757

58−-- | Return groff man representation of document.

58+-- | Return roff man representation of document.

5959pandocToMan :: PandocMonad m => WriterOptions -> Pandoc -> StateT WriterState m Text

6060pandocToMan opts (Pandoc meta blocks) = do

6161 let colwidth = if writerWrapText opts == WrapAuto

@@ -116,7 +116,7 @@ noteToMan opts num note = do

116116 return $ marker $$ contents

117117

118118-- We split inline lists into sentences, and print one sentence per

119−-- line. groff/troff treats the line-ending period differently.

119+-- line. roff treats the line-ending period differently.

120120-- See http://code.google.com/p/pandoc/issues/detail?id=148.

121121

122122-- | Convert Pandoc block element to man.

src/Text/Pandoc/Writers/Ms.hs+4−4

@@ -26,7 +26,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

2626 Stability : alpha

2727 Portability : portable

2828

29−Conversion of 'Pandoc' documents to groff ms format.

29+Conversion of 'Pandoc' documents to roff ms format.

3030

3131TODO:

3232

@@ -69,7 +69,7 @@ writeMs :: PandocMonad m => WriterOptions -> Pandoc -> m Text

6969writeMs opts document =

7070 evalStateT (pandocToMs opts document) defaultWriterState

7171

72−-- | Return groff ms representation of document.

72+-- | Return roff ms representation of document.

7373pandocToMs :: PandocMonad m => WriterOptions -> Pandoc -> MS m Text

7474pandocToMs opts (Pandoc meta blocks) = do

7575 let colwidth = if writerWrapText opts == WrapAuto

@@ -123,7 +123,7 @@ toSmallCaps opts (c:cs)

123123 | otherwise = escapeStr opts [c] ++ toSmallCaps opts cs

124124

125125-- We split inline lists into sentences, and print one sentence per

126−-- line. groff/troff treats the line-ending period differently.

126+-- line. roff treats the line-ending period differently.

127127-- See http://code.google.com/p/pandoc/issues/detail?id=148.

128128

129129blockToMs :: PandocMonad m

@@ -372,7 +372,7 @@ inlineToMs opts (Strong lst) =

372372inlineToMs opts (Strikeout lst) = do

373373 contents <- inlineListToMs opts lst

374374 -- we use grey color instead of strikeout, which seems quite

375− -- hard to do in groff for arbitrary bits of text

375+ -- hard to do in roff for arbitrary bits of text

376376 return $ text "\\m[strikecolor]" <> contents <> text "\\m[]"

377377inlineToMs opts (Superscript lst) = do

378378 contents <- inlineListToMs opts lst

src/Text/Pandoc/Writers/Roff.hs+2−2

@@ -26,7 +26,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

2626 Stability : alpha

2727 Portability : portable

2828

29−Common functions for groff writers (man, ms).

29+Common functions for roff writers (man, ms).

3030-}

3131

3232module Text.Pandoc.Writers.Roff (

@@ -89,7 +89,7 @@ combiningAccentsMap = Map.fromList combiningAccents

8989essentialEscapes :: Map.Map Char String

9090essentialEscapes = Map.fromList standardEscapes

9191

92−-- | Escape special characters for groff.

92+-- | Escape special characters for roff.

9393escapeString :: EscapeMode -> String -> String

9494escapeString _ [] = []

9595escapeString escapeMode ('\n':'.':xs) =