Skip to content

Commit 6742492

Browse files
authored
Merge pull request #145 from Omikhleia/fix-multiples-citations
feat: Use SILE's 0.15.10 "cites" for multiple bibliography citations
2 parents a6f9cc5 + 4ea14c4 commit 6742492

14 files changed

+67
-51
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ For casual readers, this collection notably aims at easily converting Djot or Ma
1515

1616
## Installation
1717

18-
This module collection requires SILE v0.14 or upper.
18+
This module collection requires SILE v0.14 or upper (recommended: v0.15.10).
1919

2020
Installation relies on the **luarocks** package manager.
2121

@@ -153,7 +153,7 @@ This is but an overview. For more details, please refer to the provided example
153153
- Raw inline HTML convenience subset in Markdown
154154
- Advanced use of symbols in Djot (variable substitution ,and templating)
155155
- Advanced configuration (e.g. Markdown variants, headings shifting, etc.)
156-
- Bibliography citations (when appropriate support is enabled)
156+
- Bibliography citations
157157

158158
## Use with the resilient collection
159159

examples/biblio.dj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Selected bibliography
2+
3+
:_BIBLIOGRAPHY_:

examples/introduction.dj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Yet, these options remain available under the hood for those seeking a blend of
2828

2929
### Standard installation
3030

31-
This module collection requires SILE v0.14 or upper.
31+
This module collection requires SILE v0.14 (recommended: v0.15.10 or upper).
3232

3333
Installation relies on the *luarocks* package manager.
3434
To install the latest version, you may use the provided “rockspec”:
@@ -148,7 +148,7 @@ Let's illustrate this for Djot, but the same applies to Markdown.
148148

149149
{custom-style=CodeBlock}
150150
:::
151-
```
151+
```sil
152152
\use[module=packages.djot]
153153
\include[src=somefile.dj]
154154
```
@@ -159,7 +159,7 @@ Again, the same applies to Markdown.
159159

160160
{custom-style=CodeBlock}
161161
:::
162-
```
162+
```sil
163163
\begin[type=djot]{raw}
164164
Some *Djot* content
165165
\end{raw}

examples/lightweight-markup.dj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Beyond technical considerations, it's also worth examining the functionality of
6363
Markdown can be intricate, with subtle nuances where even a single space can trigger unexpected effects.
6464
It exhibits non-intuitive behaviors, such as the use of indentation to denote code blocks.
6565
There are inconsistent outcomes with lists, emphases, headings...
66-
See John MacFarlane's ["Beyond Markdown"](https://johnmacfarlane.net/beyond-markdown.html) essay for some more examples, and the reasons that led him propose Djot.
66+
See John MacFarlane's ["Beyond Markdown"](https://johnmacfarlane.net/beyond-markdown.html) essay for some more examples, and the reasons that led him propose Djot [@djot:macfarlane2018].
6767

6868
: Extensibility
6969

examples/markdown-djot.bib

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
11
@book{sile,
22
title = {The SILE Book},
33
author = {Cozens, Simon and Maclennan, Caleb and Nicole, Olivier and Willis, Didier},
4-
year = {2014–202X},
4+
year = {2025},
5+
edition = {version 0.15.10},
56
}
67

78
@book{sile:willis2021,
89
title = {The re·sil·ient collection of classes & packages for SILE: User Guide},
910
author = {Willis, Didier},
10-
year = {2021–},
11+
year = {2025},
1112
}
1213

1314
@book{sile:willis2022,
1415
title = {Markdown and Djot to PDF with SILE: Ultimate Guide & Showcase Document},
1516
author = {Willis, Didier},
16-
year = {2022–},
17+
origdate = {2022},
18+
year = {2025},
1719
}
1820

1921
@book{sile:willis2024,
2022
title = {SILE and the Hydra of Maths. Showcase & Critical Assessment 2024},
2123
author = {Willis, Didier},
2224
year = {2024},
2325
}
26+
27+
@article{djot:macfarlane2018,
28+
author = {MacFarlane, John},
29+
title = {Beyond Markdown},
30+
year = {2018},
31+
url = {https://talk.commonmark.org/t/beyond-markdown/2787},
32+
}

examples/sile-and-djot.dj

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -524,16 +524,17 @@ This implementation, however, recognizes a simplified subset of the Pandoc citat
524524
:::
525525
```
526526
I wrote a whole book on mathematics with SILE [@sile:willis2024].
527+
... also supported [@sile:willis2024; @sile:willis2022].
527528
... a "master document" [@sile:willis2021, part 1].
528-
... _The SILE Book_ for more information [@sile, chapter 5].
529529
```
530530
:::
531531

532532
I wrote whole book on mathematics with SILE [@sile:willis2024].
533+
Note that multiple citations are also supported [@sile:willis2024; @sile:willis2022].
533534

534535
How to load bibliographies and configure citation styles is beyond the scope of this manual.
535-
If you are using the resilient collection, the most natural way to do this is a "master document" [@sile:willis2021, part 1].
536-
Note that support for biblibraphies in SILE is an experimental feature, so you may also want to check _The SILE Book_ for more information [@sile, chapter 5].
536+
With the resilient collection, the most natural way to do this is a "master document" [@sile:willis2021, part 1].
537+
For more information, you may also want to check _The SILE Book_ [@sile, chapter 5].
537538

538539
{#djot-symbols}
539540
### Symbols
@@ -1422,7 +1423,7 @@ For instance, you can include a Djot file with shifted headings like this:
14221423

14231424
{custom-style=CodeBlock}
14241425
:::
1425-
```
1426+
```sil
14261427
\include[src=somefile.dj, shift_headings=1]
14271428
```
14281429
:::
@@ -1431,7 +1432,7 @@ For document classes supporting it (in particular, the *resilient* book class),
14311432

14321433
{custom-style=CodeBlock}
14331434
:::
1434-
```
1435+
```sil
14351436
\include[src=somefile.dj, shift_headings=-1]
14361437
```
14371438
:::

examples/sile-and-markdown-manual-styles.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -982,8 +982,6 @@ sectioning-appendix-main-number:
982982
origin: "resilient.book"
983983
style:
984984
numbering:
985-
before:
986-
text: "Appendix "
987985
display: "ALPHA"
988986

989987
sectioning-appendix-ref-number:

examples/sile-and-markdown-manual.silm

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ metadata:
1010
- Pandoc
1111
authors: Didier Willis
1212
publisher: Omikhleia
13-
pubdate: 2024-03-01
13+
pubdate: 2025-03-21
1414
url: https://github.com/Omikhleia/markdown.sile
15-
copyright: © 2022–2024, Didier Willis.
15+
copyright: © 2022–2025, Didier Willis.
1616
legal: |
1717
This material may be distributed only subject to the terms and conditions
1818
set forth in the Creative Commons Attribution, Share-Alike License,
@@ -37,22 +37,25 @@ sile:
3737
layout: division 9
3838
resolution: 300
3939
settings:
40-
textsubsuper.fake: false
40+
textsubsuper.fake: true
4141
autodoc.highlighting: true
4242
document.baselineskip: 1.2em
43-
# typesetter.italicCorrection: true # Not yet available in SILE 0.14.x
43+
typesetter.italicCorrection: true
4444
packages:
4545
- autodoc-resilient # REQUIRED FOR RESILIENT, do not use regular autodoc
4646
- dropcaps
4747
- resilient.defn
4848
- resilient.poetry
49-
chapters:
50-
- toc.dj
51-
- extra-styles.dj
52-
- introduction.dj
53-
- lightweight-markup.dj
54-
- sile-and-djot.dj
55-
- sile-and-markdown.md
56-
- sile-and-pandoc.dj
57-
- pandoc-tables.pandoc
58-
- final-notes.dj
49+
content:
50+
chapters:
51+
- toc.dj
52+
- extra-styles.dj
53+
- introduction.dj
54+
- lightweight-markup.dj
55+
- sile-and-djot.dj
56+
- sile-and-markdown.md
57+
- sile-and-pandoc.dj
58+
- pandoc-tables.pandoc
59+
- file: final-notes.dj
60+
content:
61+
- biblio.dj

examples/sile-and-markdown.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -512,16 +512,17 @@ This implementation recognizes a simplified subset of the Pandoc citation syntax
512512
::: {custom-style=CodeBlock}
513513
```
514514
I wrote a whole book on mathematics with SILE [@sile:willis2024].
515+
... also supported [@sile:willis2024; @sile:willis2022].
515516
... a "master document" [@sile:willis2021, part 1].
516-
... _The SILE Book_ for more information [@sile, chapter 5].
517517
```
518518
:::
519519

520520
I wrote whole book on mathematics with SILE [@sile:willis2024].
521+
Note that multiple citations are also supported [@sile:willis2024; @sile:willis2022].
521522

522523
How to load bibliographies and configure citation styles is beyond the scope of this manual.
523-
If you are using the resilient collection, the most natural way to do this is a "master document" [@sile:willis2021, part 1].
524-
Note that support for biblibraphies in SILE is an experimental feature, so you may also want to check _The SILE Book_ for more information [@sile, chapter 5].
524+
With the resilient collection, the most natural way to do this is a "master document" [@sile:willis2021, part 1].
525+
For more information, you may also want to check _The SILE Book_ [@sile, chapter 5].
525526

526527
### Symbols
527528

@@ -895,15 +896,13 @@ In most cases, the content is rendered as verbatim text, with some exceptions de
895896
Erm... Markdown supports yet another syntax for loosely defined verbatim code blocks, which is the "indented code block" syntax.
896897
This author would rather not recommend using it, and frow upon the indentation ambiguities it introduces in some cases.
897898

898-
::: {custom-style=CodeBlock}
899-
This is an indented code block.
900-
:::
899+
This is a code block.
901900

902901
This is obtained by indenting the content by at least four spaces...
903902

904903
::: {custom-style=CodeBlock}
905904
```
906-
This is an indented code block.
905+
This is a code block.
907906
```
908907
:::
909908

@@ -1326,15 +1325,15 @@ In SIL documents, you can pass such options to the `\include` command or the `ra
13261325
For instance, you can include a Markdown file with shifted headings like this:
13271326

13281327
::: {custom-style=CodeBlock}
1329-
```
1328+
```sil
13301329
\include[src=somefile.md, shift_headings=1]
13311330
```
13321331
:::
13331332

13341333
For document classes supporting it (in particular, the **resilient** book class), this feature also allows you to access levels above the default scheme, such as "parts".
13351334

13361335
::: {custom-style=CodeBlock}
1337-
```
1336+
```sil
13381337
\include[src=somefile.md, shift_headings=-1]
13391338
```
13401339
:::
@@ -1356,7 +1355,7 @@ Available options are: `smart`, `smart_primes`, `strikeout`, `mark`, `subscript`
13561355
For instance, to disable the smart typography feature:
13571356

13581357
::: {custom-style=CodeBlock}
1359-
```
1358+
```sil
13601359
\include[src=somefile.md, smart=false]
13611360
```
13621361
:::

examples/sile-and-pandoc.dj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Once the package is loaded, the `\autodoc:command{\include[src=<file>]}`{=sile}
4646

4747
{custom-style=CodeBlock}
4848
:::
49-
```
49+
```sil
5050
\use[module=packages.pandocast]
5151
\include[src=somefile.pandoc]
5252
```

0 commit comments

Comments
 (0)