Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
pandoc/test/command/3539.md

254 lines
4.4 KiB
Markdown
Raw Normal View History

LaTeX reader: add Support for `glossaries` and `acronym` package (#3589) Acronyms are not resolved by the reader, but acronym and glossary information is put into attributes on Spans so that they can be processed in filters.
2017-08-16 19:24:46 +02:00
# Commands of [glossaries package](ftp://ftp.tu-chemnitz.de/pub/tex/macros/latex/contrib/glossaries/glossaries-code.pdf)
```
% pandoc -f latex -t native
Many programming languages provide \glspl{API}. Each \gls{API} should provide a documentation.
^D
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
[ Para
Switch from pretty-simple to pretty-show for native output. Update tests. Reason: it turns out that the native output generated by pretty-simple isn't always readable by the native reader. According to https://github.com/cdepillabout/pretty-simple/issues/99 it is not a design goal of the library that the rendered values be readable using 'read'. This makes it unsuitable for our purposes. pretty-show is a bit slower and it uses 4-space indents (non-configurable), but it doesn't have this serious drawback.
2021-09-29 06:17:53 +02:00
[ Str "Many"
, Space
, Str "programming"
, Space
, Str "languages"
, Space
, Str "provide"
, Space
, Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "plural+short" )
]
)
[ Str "APIs" ]
, Str "."
, Space
, Str "Each"
, Space
, Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+short" )
]
)
[ Str "API" ]
, Space
, Str "should"
, Space
, Str "provide"
, Space
, Str "a"
, Space
, Str "documentation."
]
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
]
LaTeX reader: add Support for `glossaries` and `acronym` package (#3589) Acronyms are not resolved by the reader, but acronym and glossary information is put into attributes on Spans so that they can be processed in filters.
2017-08-16 19:24:46 +02:00
```
```
% pandoc -f latex -t native
\Glsdesc{API} XYZ ist not as performant as \glsdesc{API} ZXY.
^D
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
[ Para
Switch from pretty-simple to pretty-show for native output. Update tests. Reason: it turns out that the native output generated by pretty-simple isn't always readable by the native reader. According to https://github.com/cdepillabout/pretty-simple/issues/99 it is not a design goal of the library that the rendered values be readable using 'read'. This makes it unsuitable for our purposes. pretty-show is a bit slower and it uses 4-space indents (non-configurable), but it doesn't have this serious drawback.
2021-09-29 06:17:53 +02:00
[ Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+long" )
]
)
[ Str "API" ]
, Space
, Str "XYZ"
, Space
, Str "ist"
, Space
, Str "not"
, Space
, Str "as"
, Space
, Str "performant"
, Space
, Str "as"
, Space
, Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+long" )
]
)
[ Str "API" ]
, Space
, Str "ZXY."
]
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
]
LaTeX reader: add Support for `glossaries` and `acronym` package (#3589) Acronyms are not resolved by the reader, but acronym and glossary information is put into attributes on Spans so that they can be processed in filters.
2017-08-16 19:24:46 +02:00
```
```
% pandoc -f latex -t native
\Acrlong{API} XYZ ist not as performant as \acrlong{API} ZXY.
^D
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
[ Para
Switch from pretty-simple to pretty-show for native output. Update tests. Reason: it turns out that the native output generated by pretty-simple isn't always readable by the native reader. According to https://github.com/cdepillabout/pretty-simple/issues/99 it is not a design goal of the library that the rendered values be readable using 'read'. This makes it unsuitable for our purposes. pretty-show is a bit slower and it uses 4-space indents (non-configurable), but it doesn't have this serious drawback.
2021-09-29 06:17:53 +02:00
[ Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+long" )
]
)
[ Str "API" ]
, Space
, Str "XYZ"
, Space
, Str "ist"
, Space
, Str "not"
, Space
, Str "as"
, Space
, Str "performant"
, Space
, Str "as"
, Space
, Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+long" )
]
)
[ Str "API" ]
, Space
, Str "ZXY."
]
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
]
LaTeX reader: add Support for `glossaries` and `acronym` package (#3589) Acronyms are not resolved by the reader, but acronym and glossary information is put into attributes on Spans so that they can be processed in filters.
2017-08-16 19:24:46 +02:00
```
```
% pandoc -f latex -t native
\Acrfull{API} XYZ ist not as performant as \acrfull{API} ZXY.
^D
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
[ Para
Switch from pretty-simple to pretty-show for native output. Update tests. Reason: it turns out that the native output generated by pretty-simple isn't always readable by the native reader. According to https://github.com/cdepillabout/pretty-simple/issues/99 it is not a design goal of the library that the rendered values be readable using 'read'. This makes it unsuitable for our purposes. pretty-show is a bit slower and it uses 4-space indents (non-configurable), but it doesn't have this serious drawback.
2021-09-29 06:17:53 +02:00
[ Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+full" )
]
)
[ Str "API" ]
, Space
, Str "XYZ"
, Space
, Str "ist"
, Space
, Str "not"
, Space
, Str "as"
, Space
, Str "performant"
, Space
, Str "as"
, Space
, Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+full" )
]
)
[ Str "API" ]
, Space
, Str "ZXY."
]
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
]
LaTeX reader: add Support for `glossaries` and `acronym` package (#3589) Acronyms are not resolved by the reader, but acronym and glossary information is put into attributes on Spans so that they can be processed in filters.
2017-08-16 19:24:46 +02:00
```
```
% pandoc -f latex -t native
\Acrshort{API} XYZ ist not as performant as \acrshort{API} ZXY.
^D
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
[ Para
Switch from pretty-simple to pretty-show for native output. Update tests. Reason: it turns out that the native output generated by pretty-simple isn't always readable by the native reader. According to https://github.com/cdepillabout/pretty-simple/issues/99 it is not a design goal of the library that the rendered values be readable using 'read'. This makes it unsuitable for our purposes. pretty-show is a bit slower and it uses 4-space indents (non-configurable), but it doesn't have this serious drawback.
2021-09-29 06:17:53 +02:00
[ Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+abbrv" )
]
)
[ Str "API" ]
, Space
, Str "XYZ"
, Space
, Str "ist"
, Space
, Str "not"
, Space
, Str "as"
, Space
, Str "performant"
, Space
, Str "as"
, Space
, Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+abbrv" )
]
)
[ Str "API" ]
, Space
, Str "ZXY."
]
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
]
LaTeX reader: add Support for `glossaries` and `acronym` package (#3589) Acronyms are not resolved by the reader, but acronym and glossary information is put into attributes on Spans so that they can be processed in filters.
2017-08-16 19:24:46 +02:00
```
# Commands of [acronym package](ftp://ftp.mpi-sb.mpg.de/pub/tex/mirror/ftp.dante.de/pub/tex/macros/latex/contrib/acronym/acronym.pdf)
```
% pandoc -f latex -t native
Many programming languages provide \acp{API}. Each \ac{API} should provide a documentation.
^D
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
[ Para
Switch from pretty-simple to pretty-show for native output. Update tests. Reason: it turns out that the native output generated by pretty-simple isn't always readable by the native reader. According to https://github.com/cdepillabout/pretty-simple/issues/99 it is not a design goal of the library that the rendered values be readable using 'read'. This makes it unsuitable for our purposes. pretty-show is a bit slower and it uses 4-space indents (non-configurable), but it doesn't have this serious drawback.
2021-09-29 06:17:53 +02:00
[ Str "Many"
, Space
, Str "programming"
, Space
, Str "languages"
, Space
, Str "provide"
, Space
, Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "plural+short" )
]
)
[ Str "APIs" ]
, Str "."
, Space
, Str "Each"
, Space
, Span
( ""
, []
, [ ( "acronym-label" , "API" )
, ( "acronym-form" , "singular+short" )
]
)
[ Str "API" ]
, Space
, Str "should"
, Space
, Str "provide"
, Space
, Str "a"
, Space
, Str "documentation."
]
Use pretty-simple to format native output. Previously we used our own homespun formatting. But this produces over-long lines that aren't ideal for diffs in tests. Easier to use something off-the-shelf and standard. Closes #7580. Performance is slower by about a factor of 10, but this isn't really a problem because native isn't suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
2021-09-19 21:09:51 +02:00
]
LaTeX reader: add Support for `glossaries` and `acronym` package (#3589) Acronyms are not resolved by the reader, but acronym and glossary information is put into attributes on Spans so that they can be processed in filters.
2017-08-16 19:24:46 +02:00
```
Reference in a new issue Copy permalink