Add --list-tables option.

[API change] Add writerListTables to WriterOptions. RST writer: Remove sensitivity to "list-table" class in table attributes. Instead, just check `writerListTables` in writer options. See #4564.
jgm · Sep 29, 2022 · 48d0bfc · 48d0bfc
1 parent 57fd3c4
commit 48d0bfc
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 4 deletions.
diff --git a/MANUAL.txt b/MANUAL.txt
@@ -1028,6 +1028,10 @@ header when requesting a document from a URL:
 
 :   *Deprecated synonym for `--markdown-headings=atx`.*
 
+`--list-tables`
+
+:   Render tables as list tables in RST output.
+
 `--top-level-division=default`|`section`|`chapter`|`part`
 
 :   Treat top-level headings as the given division type in
@@ -1900,6 +1904,10 @@ To include the built-in citeproc filter, use either `citeproc` or
 | ```                              | ```                               |
 +----------------------------------+-----------------------------------+
 | ```                              | ``` yaml                          |
+| --list-tables                    | list-tables: true                 |
+| ```                              | ```                               |
++----------------------------------+-----------------------------------+
+| ```                              | ``` yaml                          |
 | --top-level-division chapter     | top-level-division: chapter       |
 | ```                              | ```                               |
 +----------------------------------+-----------------------------------+

diff --git a/src/Text/Pandoc/App/CommandLineOptions.hs b/src/Text/Pandoc/App/CommandLineOptions.hs
@@ -586,6 +586,12 @@ options =
                   "setext|atx")
                   ""
 
+    , Option "" ["list-tables"]
+                 (NoArg
+                  (\opt -> do
+                    return opt { optListTables = True } ))
+                 "" -- "Use list tables for RST"
+
     , Option "" ["listings"]
                  (NoArg
                   (\opt -> return opt { optListings = True }))

diff --git a/src/Text/Pandoc/App/Opt.hs b/src/Text/Pandoc/App/Opt.hs
@@ -135,6 +135,7 @@ data Opt = Opt
     , optPdfEngineOpts         :: [String]   -- ^ Flags to pass to the engine
     , optSlideLevel            :: Maybe Int  -- ^ Header level that creates slides
     , optSetextHeaders         :: Bool       -- ^ Use atx headers for markdown level 1-2
+    , optListTables            :: Bool       -- ^ Use list tables for RST
     , optAscii                 :: Bool       -- ^ Prefer ascii output
     , optDefaultImageExtension :: Text       -- ^ Default image extension
     , optExtractMedia          :: Maybe FilePath -- ^ Path to extract embedded media
@@ -215,6 +216,7 @@ instance FromJSON Opt where
        <*> o .:? "pdf-engine-opts" .!= optPdfEngineOpts defaultOpts
        <*> o .:? "slide-level"
        <*> o .:? "setext-headers" .!= optSetextHeaders defaultOpts
+       <*> o .:? "list-tables" .!= optListTables defaultOpts
        <*> o .:? "ascii" .!= optAscii defaultOpts
        <*> o .:? "default-image-extension" .!= optDefaultImageExtension defaultOpts
        <*> o .:? "extract-media"
@@ -609,6 +611,8 @@ doOpt (k,v) = do
           "atx"    -> o{ optSetextHeaders = False }
           "setext" -> o{ optSetextHeaders = True }
           _        -> o)
+    "list-tables" ->
+      parseJSON v >>= \x -> return (\o -> o{ optListTables = x })
     "ascii" ->
       parseJSON v >>= \x -> return (\o -> o{ optAscii = x })
     "default-image-extension" ->
@@ -745,6 +749,7 @@ defaultOpts = Opt
     , optPdfEngineOpts         = []
     , optSlideLevel            = Nothing
     , optSetextHeaders         = False
+    , optListTables            = False
     , optAscii                 = False
     , optDefaultImageExtension = ""
     , optExtractMedia          = Nothing

diff --git a/src/Text/Pandoc/App/OutputSettings.hs b/src/Text/Pandoc/App/OutputSettings.hs
@@ -224,6 +224,7 @@ optToOutputSettings opts = do
         , writerSlideLevel       = optSlideLevel opts
         , writerHighlightStyle   = hlStyle
         , writerSetextHeaders    = optSetextHeaders opts
+        , writerListTables       = optListTables opts
         , writerEpubSubdirectory = T.pack $ optEpubSubdirectory opts
         , writerEpubMetadata     = epubMetadata
         , writerEpubFonts        = optEpubFonts opts

diff --git a/src/Text/Pandoc/Options.hs b/src/Text/Pandoc/Options.hs
@@ -312,6 +312,7 @@ data WriterOptions = WriterOptions
   , writerHighlightStyle    :: Maybe Style  -- ^ Style to use for highlighting
                                            -- (Nothing = no highlighting)
   , writerSetextHeaders     :: Bool       -- ^ Use setext headers for levels 1-2 in markdown
+  , writerListTables        :: Bool       -- ^ Use list tables for RST tables
   , writerEpubSubdirectory  :: Text       -- ^ Subdir for epub in OCF
   , writerEpubMetadata      :: Maybe Text -- ^ Metadata to include in EPUB
   , writerEpubFonts         :: [FilePath] -- ^ Paths to fonts to embed
@@ -347,6 +348,7 @@ instance Default WriterOptions where
                       , writerListings         = False
                       , writerHighlightStyle   = Just pygments
                       , writerSetextHeaders    = False
+                      , writerListTables       = False
                       , writerEpubSubdirectory = "EPUB"
                       , writerEpubMetadata     = Nothing
                       , writerEpubFonts        = []

diff --git a/src/Text/Pandoc/Writers/RST.hs b/src/Text/Pandoc/Writers/RST.hs
@@ -311,7 +311,7 @@ blockToRST (CodeBlock (_,classes,kvs) str) = do
 blockToRST (BlockQuote blocks) = do
   contents <- blockListToRST blocks
   return $ nest 3 contents <> blankline
-blockToRST (Table attrs blkCapt specs thead tbody tfoot) = do
+blockToRST (Table _attrs blkCapt specs thead tbody tfoot) = do
   let (caption, aligns, widths, headers, rows) = toLegacyTable blkCapt specs thead tbody tfoot
   caption' <- inlineListToRST caption
   let blocksToDoc opts bs = do
@@ -330,7 +330,7 @@ blockToRST (Table attrs blkCapt specs thead tbody tfoot) = do
         if offset tbl' > writerColumns opts
           then renderGrid
           else return tbl'
-      isList = any ("list-table" ==) $ (\(_, classes, _) -> classes) attrs
+      isList = writerListTables opts
       renderList = tableToRSTList caption (map (const AlignDefault) aligns)
                     widths headers rows
       rendered

diff --git a/test/command/4564.md b/test/command/4564.md
@@ -1,7 +1,7 @@
 ```
-% pandoc -f native -t rst
+% pandoc -f native -t rst --list-tables
 [BlockQuote
- [Table ("",["list-table"],[]) (Caption Nothing
+ [Table ("",[],[]) (Caption Nothing
   [])
   [(AlignDefault,ColWidth 0.1527777777777778)
   ,(AlignDefault,ColWidth 0.1388888888888889)