git.iko.soy/typeable/pandoc
on master help sign in
Org reader: support figure labels

Figure labels given as `#+LABEL: thelabel` are used as the ID of the respective image. This allows e.g. the LaTeX to add proper `\label` markup. This fixes half of #2496 and #2999.

commit0f3f5ce1a1569d02dcb858b45dca55cb5d488358 authorAlbert Krewinkel <albert@zeitkraut.de> dateSun 26 Jun 2016, 20:19 (10 years ago) parent7f4ee83
2 files changed+47−32
compare with master
unifiedsplit
src/Text/Pandoc/Readers/Org/Blocks.hs+6−1 tests/Tests/Readers/Org.hs+41−31
src/Text/Pandoc/Readers/Org/Blocks.hs+6−1
@@ -98,6 +98,7 @@ block = choice [ mempty <$ blanklines
9898-- | Attributes that may be added to figures (like a name or caption).
9999data BlockAttributes = BlockAttributes
100100 { blockAttrName :: Maybe String
101+ , blockAttrLabel :: Maybe String
101102 , blockAttrCaption :: Maybe (F Inlines)
102103 , blockAttrKeyValues :: [(String, String)]
103104 }
@@ -117,12 +118,14 @@ blockAttributes = try $ do
117118 let caption = foldl' (appendValues "CAPTION") Nothing kv
118119 let kvAttrs = foldl' (appendValues "ATTR_HTML") Nothing kv
119120 let name = lookup "NAME" kv
121+ let label = lookup "LABEL" kv
120122 caption' <- maybe (return Nothing)
121123 (fmap Just . parseFromString inlines)
122124 caption
123125 kvAttrs' <- parseFromString keyValues . (++ "\n") $ fromMaybe mempty kvAttrs
124126 return $ BlockAttributes
125127 { blockAttrName = name
128+ , blockAttrLabel = label
126129 , blockAttrCaption = caption'
127130 , blockAttrKeyValues = kvAttrs'
128131 }
@@ -131,6 +134,7 @@ blockAttributes = try $ do
131134 attrCheck attr =
132135 case attr of
133136 "NAME" -> True
137+ "LABEL" -> True
134138 "CAPTION" -> True
135139 "ATTR_HTML" -> True
136140 _ -> False
@@ -415,9 +419,10 @@ figure = try $ do
415419 guard . not . isNothing . blockAttrCaption $ figAttrs
416420 guard (isImageFilename src)
417421 let figName = fromMaybe mempty $ blockAttrName figAttrs
422+ let figLabel = fromMaybe mempty $ blockAttrLabel figAttrs
418423 let figCaption = fromMaybe mempty $ blockAttrCaption figAttrs
419424 let figKeyVals = blockAttrKeyValues figAttrs
420− let attr = (mempty, mempty, figKeyVals)
425+ let attr = (figLabel, mempty, figKeyVals)
421426 return $ (B.para . B.imageWith attr src (withFigPrefix figName) <$> figCaption)
422427 where
423428 withFigPrefix :: String -> String
tests/Tests/Readers/Org.hs+41−31
@@ -767,37 +767,47 @@ tests =
767767 , "#+END_COMMENT"] =?>
768768 (mempty::Blocks)
769769
770− , "Figure" =:
771− unlines [ "#+caption: A very courageous man."
772− , "#+name: goodguy"
773− , "[[edward.jpg]]"
774− ] =?>
775− para (image "edward.jpg" "fig:goodguy" "A very courageous man.")
776−
777− , "Figure with no name" =:
778− unlines [ "#+caption: I've been through the desert on this"
779− , "[[horse.png]]"
780− ] =?>
781− para (image "horse.png" "fig:" "I've been through the desert on this")
782−
783− , "Figure with `fig:` prefix in name" =:
784− unlines [ "#+caption: Used as a metapher in evolutionary biology."
785− , "#+name: fig:redqueen"
786− , "[[the-red-queen.jpg]]"
787− ] =?>
788− para (image "the-red-queen.jpg" "fig:redqueen"
789− "Used as a metapher in evolutionary biology.")
790−
791− , "Figure with HTML attributes" =:
792− unlines [ "#+CAPTION: mah brain just explodid"
793− , "#+NAME: lambdacat"
794− , "#+ATTR_HTML: :style color: blue :role button"
795− , "[[lambdacat.jpg]]"
796− ] =?>
797− let kv = [("style", "color: blue"), ("role", "button")]
798− name = "fig:lambdacat"
799− caption = "mah brain just explodid"
800− in para (imageWith (mempty, mempty, kv) "lambdacat.jpg" name caption)
770+ , testGroup "Figures" $
771+ [ "Figure" =:
772+ unlines [ "#+caption: A very courageous man."
773+ , "#+name: goodguy"
774+ , "[[edward.jpg]]"
775+ ] =?>
776+ para (image "edward.jpg" "fig:goodguy" "A very courageous man.")
777+
778+ , "Figure with no name" =:
779+ unlines [ "#+caption: I've been through the desert on this"
780+ , "[[horse.png]]"
781+ ] =?>
782+ para (image "horse.png" "fig:" "I've been through the desert on this")
783+
784+ , "Figure with `fig:` prefix in name" =:
785+ unlines [ "#+caption: Used as a metapher in evolutionary biology."
786+ , "#+name: fig:redqueen"
787+ , "[[the-red-queen.jpg]]"
788+ ] =?>
789+ para (image "the-red-queen.jpg" "fig:redqueen"
790+ "Used as a metapher in evolutionary biology.")
791+
792+ , "Figure with HTML attributes" =:
793+ unlines [ "#+CAPTION: mah brain just explodid"
794+ , "#+NAME: lambdacat"
795+ , "#+ATTR_HTML: :style color: blue :role button"
796+ , "[[lambdacat.jpg]]"
797+ ] =?>
798+ let kv = [("style", "color: blue"), ("role", "button")]
799+ name = "fig:lambdacat"
800+ caption = "mah brain just explodid"
801+ in para (imageWith (mempty, mempty, kv) "lambdacat.jpg" name caption)
802+
803+ , "Labelled figure" =:
804+ unlines [ "#+CAPTION: My figure"
805+ , "#+LABEL: fig:myfig"
806+ , "[[blub.png]]"
807+ ] =?>
808+ let attr = ("fig:myfig", mempty, mempty)
809+ in para (imageWith attr "blub.png" "fig:" "My figure")
810+ ]
801811
802812 , "Footnote" =:
803813 unlines [ "A footnote[1]"