RIDDL Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
Edit page

Documentation Conventions

This page defines the conventions we use throughout this documentation.

RIDDL Snippets

Whenever we include RIDDL source code in the documentation it will be in a fixed sized font like this:

domain MyDomain is { ??? }

Notes

Whenever an incidental note needs to be presented, it will be shown in blue like this paragraph.

Recommendations

Whenever an important recommendation needs to be made it will be shown in green like this paragraph.

Warnings

Whenever a point that is often a source of confusion needs to be made, it will be shown in yellow like this paragraph.

Dangers

Whenever a point that will lead to errors or have dangerous consequences needs be made, it will be shown in red like this paragraph.

Language Definitions

Whenever an important RIDDL language definition is made, it will appear in a box like this.
https://riddl.tech/language/common/doc-conventions/
riddl.tech
CC-MAIN-2024-18
161489
application/http; msgtype=response
sha1:GFLPRKH6S3TCBX3R5TNPTLQE5VJAFDRG
<urn:uuid:948b4229-f3b1-4fb1-8e17-a57c79cf04a6>
2024-04-24T22:31:17Z
185.199.109.153
text/html
sha1:TGEISZBIFLIETYWSAWJYMUPEP4FZ64SB
<urn:uuid:4ab1a24e-ffe2-4ca1-a394-dadb0a43e3cd>
https://riddl.tech/language/common/doc-conventions/
response
<urn:uuid:d1d3087b-45ce-40cf-a705-584778c3aead>
isPartOf: CC-MAIN-2024-18
publisher: Common Crawl
description: Wide crawl of the web for April 2024
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-122
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.5-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/