From e10d5b3d5bc4de124549762b1523575c7824ca28 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Thu, 1 Nov 2018 16:46:43 -0700 Subject: Change 'groff' -> 'roff'. These formats (man, ms) are not groff-specific. --- MANUAL.txt | 16 ++++++++-------- pandoc.cabal | 4 ++-- src/Text/Pandoc/Pretty.hs | 2 +- src/Text/Pandoc/Readers/Roff.hs | 4 ++-- src/Text/Pandoc/Writers/Man.hs | 6 +++--- src/Text/Pandoc/Writers/Ms.hs | 8 ++++---- src/Text/Pandoc/Writers/Roff.hs | 4 ++-- 7 files changed, 22 insertions(+), 22 deletions(-) diff --git a/MANUAL.txt b/MANUAL.txt index 1761e393b..beb4bae7d 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -285,13 +285,13 @@ General options {.options} - `jats` ([JATS] XML) - `json` (JSON version of native AST) - `latex` ([LaTeX]) - - `man` ([groff man]) + - `man` ([roff man]) - `markdown` ([Pandoc's Markdown]) - `markdown_mmd` ([MultiMarkdown]) - `markdown_phpextra` ([PHP Markdown Extra]) - `markdown_strict` (original unextended [Markdown]) - `mediawiki` ([MediaWiki markup]) - - `ms` ([groff ms]) + - `ms` ([roff ms]) - `muse` ([Muse]), - `native` (native Haskell), - `odt` ([OpenOffice text document][ODT]) @@ -442,8 +442,8 @@ General options {.options} [TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax [Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html [Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0 -[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html -[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html +[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html +[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html [Haskell]: https://www.haskell.org [GNU Texinfo]: http://www.gnu.org/software/texinfo/ [Emacs Org mode]: http://orgmode.org @@ -861,9 +861,9 @@ Options affecting specific writers {.options} : Use only ASCII characters in output. Currently supported for XML and HTML formats (which use entities instead of UTF-8 when this option is selected), Markdown (which uses - entities), groff ms (which use hexadecimal escapes), and to + entities), roff ms (which use hexadecimal escapes), and to a limited degree LaTeX (which uses standard commands for - accented characters when possible). Groff man output uses + accented characters when possible). roff man output uses ASCII by default. `--reference-links` @@ -3334,7 +3334,7 @@ AsciiDoc Texinfo ~ It will be rendered inside a `@math` command. -groff man +roff man ~ It will be rendered verbatim without `$`'s. MediaWiki, DokuWiki @@ -3474,7 +3474,7 @@ Emacs Org mode, and ConTeXt. Inline spans and fenced code blocks with a special kind of attribute will be parsed as raw content with the designated format. For example, the following produces a raw -groff `ms` block: +roff `ms` block: ```{=ms} .MYMACRO diff --git a/pandoc.cabal b/pandoc.cabal index 2d85a771c..0f6cdbf75 100644 --- a/pandoc.cabal +++ b/pandoc.cabal @@ -20,12 +20,12 @@ description: Pandoc is a Haskell library for converting from one markup (subsets of) HTML, reStructuredText, LaTeX, DocBook, JATS, MediaWiki markup, TWiki markup, TikiWiki markup, Creole 1.0, Haddock markup, OPML, Emacs Org-Mode, Emacs Muse, txt2tags, - Vimwiki, Word Docx, ODT, EPUB, FictionBook2, groff man, + Vimwiki, Word Docx, ODT, EPUB, FictionBook2, roff man, and Textile, and it can write Markdown, reStructuredText, XHTML, HTML 5, LaTeX, ConTeXt, DocBook, JATS, OPML, TEI, OpenDocument, ODT, Word docx, PowerPoint pptx, RTF, MediaWiki, DokuWiki, ZimWiki, Textile, - groff man, groff ms, plain text, Emacs Org-Mode, + roff man, roff ms, plain text, Emacs Org-Mode, AsciiDoc, Haddock markup, EPUB (v2 and v3), FictionBook2, InDesign ICML, Muse, LaTeX beamer slides, and several kinds of HTML/JavaScript slide shows diff --git a/src/Text/Pandoc/Pretty.hs b/src/Text/Pandoc/Pretty.hs index f0990c1f8..ec1d36a68 100644 --- a/src/Text/Pandoc/Pretty.hs +++ b/src/Text/Pandoc/Pretty.hs @@ -432,7 +432,7 @@ nowrap doc = Doc $ mapWithIndex replaceSpace $ unDoc doc replaceSpace _ x = x -- | Content to print only if it comes at the beginning of a line, --- to be used e.g. for escaping line-initial `.` in groff man. +-- to be used e.g. for escaping line-initial `.` in roff man. afterBreak :: String -> Doc afterBreak s = Doc $ singleton (AfterBreak s) diff --git a/src/Text/Pandoc/Readers/Roff.hs b/src/Text/Pandoc/Readers/Roff.hs index 1283cf4e1..cd8ec94bd 100644 --- a/src/Text/Pandoc/Readers/Roff.hs +++ b/src/Text/Pandoc/Readers/Roff.hs @@ -29,7 +29,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Stability : WIP Portability : portable -Tokenizer for groff formats (man, ms). +Tokenizer for roff formats (man, ms). -} module Text.Pandoc.Readers.Roff ( FontSpec(..) @@ -705,7 +705,7 @@ linePartsToString = mconcat . map go go (RoffStr s) = s go _ = mempty --- | Tokenize a string as a sequence of groff tokens. +-- | Tokenize a string as a sequence of roff tokens. lexRoff :: PandocMonad m => SourcePos -> T.Text -> m RoffTokens lexRoff pos txt = do eithertokens <- readWithM (do setPosition pos diff --git a/src/Text/Pandoc/Writers/Man.hs b/src/Text/Pandoc/Writers/Man.hs index 29e4aa718..6572760c3 100644 --- a/src/Text/Pandoc/Writers/Man.hs +++ b/src/Text/Pandoc/Writers/Man.hs @@ -27,7 +27,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Stability : alpha Portability : portable -Conversion of 'Pandoc' documents to groff man page format. +Conversion of 'Pandoc' documents to roff man page format. -} module Text.Pandoc.Writers.Man ( writeMan) where @@ -55,7 +55,7 @@ writeMan :: PandocMonad m => WriterOptions -> Pandoc -> m Text writeMan opts document = evalStateT (pandocToMan opts document) defaultWriterState --- | Return groff man representation of document. +-- | Return roff man representation of document. pandocToMan :: PandocMonad m => WriterOptions -> Pandoc -> StateT WriterState m Text pandocToMan opts (Pandoc meta blocks) = do let colwidth = if writerWrapText opts == WrapAuto @@ -116,7 +116,7 @@ noteToMan opts num note = do return $ marker $$ contents -- We split inline lists into sentences, and print one sentence per --- line. groff/troff treats the line-ending period differently. +-- line. roff treats the line-ending period differently. -- See http://code.google.com/p/pandoc/issues/detail?id=148. -- | Convert Pandoc block element to man. diff --git a/src/Text/Pandoc/Writers/Ms.hs b/src/Text/Pandoc/Writers/Ms.hs index 6abc4bf93..202cb91ad 100644 --- a/src/Text/Pandoc/Writers/Ms.hs +++ b/src/Text/Pandoc/Writers/Ms.hs @@ -26,7 +26,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Stability : alpha Portability : portable -Conversion of 'Pandoc' documents to groff ms format. +Conversion of 'Pandoc' documents to roff ms format. TODO: @@ -69,7 +69,7 @@ writeMs :: PandocMonad m => WriterOptions -> Pandoc -> m Text writeMs opts document = evalStateT (pandocToMs opts document) defaultWriterState --- | Return groff ms representation of document. +-- | Return roff ms representation of document. pandocToMs :: PandocMonad m => WriterOptions -> Pandoc -> MS m Text pandocToMs opts (Pandoc meta blocks) = do let colwidth = if writerWrapText opts == WrapAuto @@ -123,7 +123,7 @@ toSmallCaps opts (c:cs) | otherwise = escapeStr opts [c] ++ toSmallCaps opts cs -- We split inline lists into sentences, and print one sentence per --- line. groff/troff treats the line-ending period differently. +-- line. roff treats the line-ending period differently. -- See http://code.google.com/p/pandoc/issues/detail?id=148. blockToMs :: PandocMonad m @@ -372,7 +372,7 @@ inlineToMs opts (Strong lst) = inlineToMs opts (Strikeout lst) = do contents <- inlineListToMs opts lst -- we use grey color instead of strikeout, which seems quite - -- hard to do in groff for arbitrary bits of text + -- hard to do in roff for arbitrary bits of text return $ text "\\m[strikecolor]" <> contents <> text "\\m[]" inlineToMs opts (Superscript lst) = do contents <- inlineListToMs opts lst diff --git a/src/Text/Pandoc/Writers/Roff.hs b/src/Text/Pandoc/Writers/Roff.hs index 7bf0c5ee9..2650229f2 100644 --- a/src/Text/Pandoc/Writers/Roff.hs +++ b/src/Text/Pandoc/Writers/Roff.hs @@ -26,7 +26,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Stability : alpha Portability : portable -Common functions for groff writers (man, ms). +Common functions for roff writers (man, ms). -} module Text.Pandoc.Writers.Roff ( @@ -89,7 +89,7 @@ combiningAccentsMap = Map.fromList combiningAccents essentialEscapes :: Map.Map Char String essentialEscapes = Map.fromList standardEscapes --- | Escape special characters for groff. +-- | Escape special characters for roff. escapeString :: EscapeMode -> String -> String escapeString _ [] = [] escapeString escapeMode ('\n':'.':xs) = -- cgit v1.2.3