The introduction should be written for non-techies also. The purpose of the introduction is to explain what the tutorial is about and show a capability / use case of FREME.
See this article on how to add content to this site.
The tutorials should feature some interactive API calls using jQuery. Therefore you should write the tutorial in HTML instead of markdown. You can copy this page as a template.
For demonstration purposes we included an API call to /e-translation/tilde. This tutorial covers only the most important parameters of this API endpoint. You can find an extensive overview on this API call in the complete API documentation.
Query string parameter input
Specify the text you want to translate here.
Query string parameter source-lang
Enter the language you want to translate from
Query string parameter target-lang
Enter the language you want to translate to
Query string parameter informat
Specifies the format of the input data. In this example we submit plaintext so we set this parameter to "text"
Query string parameter outformat
Specifies the format of the data returned by FREME. In this example we want to return JSON-LD data that can be easily processed by many programming languages so we specify "outformat=json-ld"
You should provide a cURL call for every example API call mentioned above. Ensure to replace the site URL and the api URL (e.g. api-dev.freme-project.eu/current) of any internal (FREME) endpoint by the generic url pattern: {{site.apiBasePath | prepend: site.apiHost | prepend: "://" | prepend: site.apiProtocol }} which will be translated to the currently valid values: https://api.freme-project.eu/current.