Adding an alias named contents to the html property of the shell-empty component

Olivier Auverlot · Olivier Auverlot · commit 1265b5f1a77b · 2025-11-22T10:37:09.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.DS_STORE
 /target
 sqlpage.db
 .idea/
diff --git a/examples/official-site/sqlpage/migrations/01_documentation.sql b/examples/official-site/sqlpage/migrations/01_documentation.sql
@@ -1533,4 +1533,14 @@ so you can also [create your own shell component](custom_components.sql#custom-s
 If you generate your own HTML from a SQL query, you can also use the `shell-empty` component to include it in a page.
 Make sure you know what you are doing, and be careful to escape the HTML properly,
 as you are stepping out of the safe SQLPage framework and into the wild world of HTML.',
-    json('[{"component":"shell-empty", "html": "<!DOCTYPE html>\n<html>\n<head>\n  <title>My page</title>\n</head>\n<body>\n  <h1>My page</h1>\n</body>\n</html>"}]'));
+    json('[{"component":"shell-empty", "html": "<!DOCTYPE html>\n<html>\n<head>\n  <title>My page</title>\n</head>\n<body>\n  <h1>My page</h1>\n</body>\n</html>"}]')),
+    ('shell','
+### Return data in a format other than HTML
+If you create a RESTful API with SQLPage and the data format transmitted to the client is not HTML, 
+you can use an alias named `contents` to enhance the readability of your code. 
+This approach is particularly useful for returning data formats such as JSON or XML.
+
+Remember to use the [http_header](component.sql?component=http%5Fheader) component beforehand to inform the client about the format of the data being sent. 
+For example, for XML, the correct [MIME](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/MIME_types/Common_types) type should be `application/xml`.
+',
+    json('[{"component":"shell-empty", "contents": "<?xml version=\"1.0\"?>\n <user>\n   <account>42</account>\n   <login>john.doe</login>\n </user>"}]'));
diff --git a/sqlpage/templates/shell-empty.handlebars b/sqlpage/templates/shell-empty.handlebars
@@ -1,2 +1,3 @@
 {{{~html~}}}
+{{{~contents~}}}
 {{~#each_row~}}{{~/each_row~}}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.DS_STORE`
`1`	`2`	`/target`
`2`	`3`	`sqlpage.db`
`3`	`4`	`.idea/`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`{{{~html~}}}`
	`2`	`+{{{~contents~}}}`
`2`	`3`	`{{~#each_row~}}{{~/each_row~}}`