use markdown support from clldutils when available

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes
 
+
+## [Unreleased]
+
+- Use markdown support from `clldutils.source` if available.
+
+
 ## [v1.2.0] - 2024-07-03
 
 - Support more flexible citation labels in `cldfviz.text`.

setup.cfg

@@ -33,6 +33,7 @@ package_dir =
     = src
 python_requires = >=3.8
 install_requires =
+    packaging
     clldutils>=3.17
     pycldf>=1.32.0
     cldfbench>=1.11.0

src/cldfviz/templates/text/util.md

@@ -59,10 +59,8 @@
 {%- endmacro %}
 
 {% macro source(src, with_anchor=False, with_link=False) -%}
-{% if with_anchor %}<a id="source-{{ src.id }}"> </a>{% endif %}{{ src.text() }}{% if with_link %}
-{% if src.get("doi") %}
- [DOI: {{ src["doi"] }}](https://doi.org/{{ src["doi"] }}){% else %}{% if src.get("url") %}
+{% if with_anchor %}<a id="source-{{ src.id }}"> </a>{% endif %}{{ source_markdown(src, with_link) }}{% if with_link %}
+{% if src.get("url") %}
  [{{ src["url"] }}]({{ src["url"] }}){% endif %}
 {% endif %}
-{% endif %}
 {%- endmacro %}

src/cldfviz/text.py

@@ -8,6 +8,8 @@
 from pycldf.ext.markdown import CLDFMarkdownText
 import jinja2
 import jinja2.meta
+from packaging.version import Version
+import clldutils
 from clldutils.misc import nfilter
 from clldutils.markup import MarkdownLink, MarkdownImageLink
 
@@ -18,6 +20,11 @@
 TEMPLATE_DIR = cldfviz.PKG_DIR.joinpath('templates', 'text')
 
 
+def source_markdown(src, with_link=False):
+    with_link = with_link and Version(clldutils.__version__) >= Version('3.21.0')
+    return src.text(**{'markdown': True} if with_link else {})
+
+
 def _add_filters(env):
     def paragraphs(s):
         return '\n\n'.join(s.split('\n'))
@@ -87,7 +94,9 @@ def render(doc: typing.Union[pathlib.Path, str],
     :return: Rendered document as string.
     """
     func_dict = func_dict or {}
-    func_dict.update({"pad_ex": functools.partial(pad_ex, escape=escape)})
+    func_dict.update({
+        "pad_ex": functools.partial(pad_ex, escape=escape),
+        "source_markdown": source_markdown})
 
     if isinstance(cldf_dict, Dataset):
         cldf_dict = {None: cldf_dict}

tests/test_text.py

@@ -110,7 +110,7 @@ def test_render_metadata(StructureDataset):
         ('ParameterTable', None, 'C', 'sd', 'Codes'),
         ('Source', None, 'Peterson2017', 'sd', 'Peterson, John. 2017.'),
         ('Source', None, '__all__', 'sd', '- '),
-        ('Source', 'with_link', 'Peterson2017', 'sd', '[DOI:'),
+        ('Source', 'with_link', 'Peterson2017', 'sd', 'doi: ['),
     ]
 )
 def test_templates(Wordlist, Generic, StructureDataset, comp, query, oid, ds, expected):
@@ -130,14 +130,14 @@ def test_templates(Wordlist, Generic, StructureDataset, comp, query, oid, ds, ex
 
 
 def test_reference_list(StructureDataset):
-    text = """# [](ParameterTable?__template__=property.md&name=name#cldf:B)
+    text = """# [](ParameterTable?__template__=property.md&property=name#cldf:B)
 
 See [](Source?ref&with_internal_ref_link#cldf:Peterson2017) and [ex](http://example.com)
 
 [References](Source?cited_only#cldf:__all__)
 """
     res = render(text, StructureDataset)
-    assert "Gender/Noun classes" in res
+    assert "# Gender/Noun classes" in res
     assert 'Peterson 2017' in res
     assert "Fitting the pieces together" in res