Overview
You will learn
- How to inline reusable snippet content with
::include[name]{params} - How to link to SAP Notes, Help Portal, APIs, and other tutorials with smart reference directives
- How to declare tested tool versions with
testedWithfrontmatter - How to render a prerequisite card with
::requires
Prerequisites
- Basic familiarity with the tutorial markdown structure (see v2-example-tutorial)
Steps
This tutorial requires hana-cloud-tutorial-1 to be completed first.
The tested environment is declared in the testedWith frontmatter above — you will see a collapsible “Tested with” panel at the top of the rendered tutorial.
Reusable snippets let you share common setup steps across tutorials. The snippet below is fetched from the _snippets/ directory at the root of the source repository.
Follow these steps to create a BTP Trial account in region eu10:
- Navigate to SAP BTP Trial.
- Select region
eu10during signup. - Complete the registration form and confirm your email.
Note: Free trial accounts expire after 365 days. Renew before expiry to keep your data.
The
{region=eu10}parameter substitutes{{param:region}}in the snippet witheu10.
Reference SAP resources inline without hard-coding URLs:
- SAP Note: SAP Note 2471802 — links to the SAP Note on me.sap.com
- Help Portal: cap/docs/about-cap — links to help.sap.com/docs/cap/docs/about-cap
- API reference:
cds.ql.SELECT— links to the CAP Node.js API docs - Tutorial cross-reference: hana-cloud-tutorial-1 — links to another tutorial
- Version badge: CAP 10 — renders a version tag
The ::requires directive renders a card linking to a prerequisite tutorial.
When you are authenticated, the card shows your completion status (Completed, In progress, or Start).
You have seen how to:
- Inline reusable snippet content with
::include[name]{params} - Link to SAP Notes, Help Portal, APIs, and other tutorials using
:note,:help,:api,:tutorial - Declare tested tool versions with
testedWithfrontmatter - Show prerequisite cards with
::requires
Resources
Discussion
Share feedback on this tutorial or join the conversation in SAP Community.