search

gbif / doc-camera-trap-guide

This guide provides recommendations for camera trap data management and publication to GBIF.
https://doi.org/10.35035/doc-0qzp-2x37
Other
0 stars 1 forks source link

index inclusions #15

Closed kcopas closed 10 months ago

kcopas commented 1 year ago

In adding the cover illustrations, I noticed a few dozen lines of term/citation references in index.en.adoc. Not sure they belong there, as that index isn't an index of terms but a index for building the AsciiDoc document. Not urgent, by any means, but just flagging it here and now before I forget.

peterdesmet commented 10 months ago

Hi Kyle, do you mean this:

https://github.com/gbif/doc-camera-trap-guide/blob/97f38058e65230b9213434577b87233c7cf8c4e1/index.en.adoc?plain=1#L21-L127

That is a list of short codes for (term) URLs. By defining them in index.en.adoc, we can use the syntax:

Terms like {deployments-deploymentID} or term:dwc[dwc:occurrenceID] expect an identifier that is:

To refer to a term without always having to repeat the URL (which is prone to error). They render as:

Screenshot 2023-11-13 at 16 31 35

I defined all those short codes in index.en.adoc based on advise by @MattBlissett, but if you think they are better defined elsewhere (e.g. separated file), let me know.

kcopas commented 10 months ago

Thanks for the clarification @peterdesmet. I think I was flagging something I didn't understand. The rationale sounds reasonable to me (thanks @MattBlissett ), so as long as it works, I'm fine with it.