foodogsquared/website
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/website.git synced 2025-02-07 09:19:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve README for SWHID include macro

Browse Source
This commit is contained in:
Gabriel Arazas 2023-03-05 14:22:17 +08:00
parent 0b570d9133
commit 4951495446
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
gems/lib/asciidoctor/swhid-inline-macro/README.adoc
View File

@ -4,6 +4,9 @@
An inline macro for easily linking link:https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html[SWHIDs].
== Synopsis
[source, asciidoc]
----
swh:$SWHID[$CAPTION]
@ -35,7 +38,7 @@ This should work with the following types of SWHIDs.
- A SWHID with only the core identifier: `swh:1:snp:6ea7d28dfd4789609e0be2b64179fc9c12931beb[]`.
- A SWHID with only one qualifier: `swh:1:cnt:ce4dd1988d2d5dfcec48252757a6fea94339ac38;lines=3-4[]`
- A SWHID with only one qualifier with a link caption: `swh:1:cnt:ce4dd1988d2d5dfcec48252757a6fea94339ac38;lines=3-4[some code text]`
- A SWHID with full contextual information.
This is as depicted from the recommended practice for writings (i.e., blog posts, technical documentation, research papers) when referring to one of the objects in the archive.