Better ReST: Function to resolve external includes? #6632
Comments
@jgm I completely missed this part! What is the Haskell equivalent of |
I think |
Thanks. It looks like what I was looking for! |
|
It doesn't seem to be working as expected. Should the pandoc/src/Text/Pandoc/Readers/RST.hs Line 464 in 49e810b |
|
"as expected" here means what? Our aim would be to have it work the way docutils tools work, to the extent possible. So see how it is processed by docutils' rsthtml.py. Unfortunately we can't reliably go relative to the directory containing the input file. Multiple input files can be specified on the command line; pandoc concatenates them before passing them to the RST reader, which therefore doesn't know which file corresponds to a particular part of the input. We could use |
Previously, when multiple file arguments were provided, pandoc simply concatenated them and passed the contents to the readers, which took a Text argument. As a result, the readers had no way of knowing which file was the source of any particular bit of text. This meant that we couldn't report accurate source positions on errors or include accurate source positions as attributes in the AST. More seriously, it meant that we couldn't resolve resource paths relative to the files containing them (see e.g. #5501, #6632, #6384, #3752). Add Text.Pandoc.Sources (exported module), with a `Sources` type and a `ToSources` class. A `Sources` wraps a list of `(SourcePos, Text)` pairs. [API change] A parsec `Stream` instance is provided for `Sources`. The module also exports versions of parsec's `satisfy` and other Char parsers that track source positions accurately from a `Sources` stream (or any instance of the new `UpdateSourcePos` class). Text.Pandoc.Parsing now exports these modified Char parsers instead of the ones parsec provides. Modified parsers to use a `Sources` as stream [API change]. The readers that previously took a `Text` argument have been modified to take any instance of `ToSources`. So, they may still be used with a `Text`, but they can also be used with a `Sources` object. In Text.Pandoc.Error, modified the constructor PandocParsecError to take a `Sources` rather than a `Text` as first argument, so parse error locations can be accurately reported. T.P.Error: showPos, do not print "-" as source name.
Previously, when multiple file arguments were provided, pandoc simply concatenated them and passed the contents to the readers, which took a Text argument. As a result, the readers had no way of knowing which file was the source of any particular bit of text. This meant that we couldn't report accurate source positions on errors or include accurate source positions as attributes in the AST. More seriously, it meant that we couldn't resolve resource paths relative to the files containing them (see e.g. #5501, #6632, #6384, #3752). Add Text.Pandoc.Sources (exported module), with a `Sources` type and a `ToSources` class. A `Sources` wraps a list of `(SourcePos, Text)` pairs. [API change] A parsec `Stream` instance is provided for `Sources`. The module also exports versions of parsec's `satisfy` and other Char parsers that track source positions accurately from a `Sources` stream (or any instance of the new `UpdateSourcePos` class). Text.Pandoc.Parsing now exports these modified Char parsers instead of the ones parsec provides. Modified parsers to use a `Sources` as stream [API change]. The readers that previously took a `Text` argument have been modified to take any instance of `ToSources`. So, they may still be used with a `Text`, but they can also be used with a `Sources` object. In Text.Pandoc.Error, modified the constructor PandocParsecError to take a `Sources` rather than a `Text` as first argument, so parse error locations can be accurately reported. T.P.Error: showPos, do not print "-" as source name.
Following up from #223 (comment)
The motivation for this feature-request is partially given at #6631
The filename in
.. includedirectives is treated as relative to the entire process's current-directory. However, I'd expect it to be relative to the file being parsed. So, if I move an RST file (along with its external includes) up/down a directory level, I don't need to change all include paths within the file.The generalization of this behaviour would be a
loadExternalInclude :: FilePath -> IO Stringtype of function that can be overridden by the library user.The text was updated successfully, but these errors were encountered: