Skip to content

Commit 2e9cfb0

Browse files
committed
Improve the documentation and the official site
1 parent e60f866 commit 2e9cfb0

File tree

3 files changed

+28
-8
lines changed

3 files changed

+28
-8
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "sqlpage"
3-
version = "0.4.3"
3+
version = "0.4.4"
44
edition = "2021"
55
description = "A SQL-only web application framework. Takes .sql files and formats the query result using pre-made configurable professional-looking components."
66
keywords = ["web", "sql", "framework"]

examples/official-site/index.sql

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
11

22
-- Using the 'shell' component at the top allows you to customize your web page, giving it a title and a description
3-
select 'shell' as component, 'sqlpage' as title, '/' as link, 'en' as lang,
4-
'Official SQLPage webpage: write web applications in SQL !' as description;
3+
select 'shell' as component,
4+
'SQLPage' as title,
5+
'file-database' as icon,
6+
'/' as link,
7+
'en' as lang,
8+
'Official SQLPage webpage: write web applications in SQL !' as description,
9+
'documentation' as menu_item;
510

611
select 'text' as component, 'SQLPage: turn any database into a webapp' as title;
7-
SELECT 'SQLPage is a powerful tool for creating websites using only SQL. With SQLPage, you can create dynamic and functional websites without the need for complex programming languages. Simply define your website using a set of predefined components and fill them with the results of your SQL queries. This allows you to quickly and easily create a website that is tailored to your specific needs and requirements.' as contents, TRUE as break, 3 as size;
12+
SELECT 'SQLPage is a powerful tool for creating websites using only SQL. With SQLPage, '||
13+
'you can create dynamic and functional websites without the need for complex programming languages. '||
14+
'Simply define your website using a set of predefined components and fill them with the results of your SQL queries. '||
15+
'This allows you to quickly and easily create a website that is tailored to your specific needs and requirements.' as contents, 5 as size;
816

917
select 'text' as component, 'SQL-only' as title;
10-
SELECT 'One of the key benefits of SQLPage is that it allows you to use your existing SQL skills to create a website. If you are already familiar with SQL, you can use SQLPage to create a website without the need to learn additional programming languages. This makes it an ideal tool for people who are not professional programmers, but still want to create a website with a database.' as contents, TRUE as break, 4 as size;
18+
SELECT 'One of the key benefits of SQLPage is that it allows you to use the SQL skills you and your team already have ' ||
19+
'to create a website. ' ||
20+
'If you are already familiar with SQL, you can create a SQL Page in a few minutes right now ' ||
21+
'without the need to learn additional programming languages. ' ||
22+
'If you are not, start learning SQL now, and you will have the level it takes to build a website in a week, versus months to learn a full-fledged programming language. ' ||
23+
'This makes SQLPage an ideal tool for people who are not professional programmers, but still need to create a website with a database: ' ||
24+
'that means data scientists, engineers, analysts, marketers, and others, who already have access to databases, ' ||
25+
'but are currently limited to creating dashboards and static reports can now create full-fledged dynamic web applications.' as contents, 4 as size;
1126

1227
select 'text' as component, 'Pre-defined components for everything' as title;
13-
SELECT 'In addition to its ease of use, SQLPage offers a wide range of features and capabilities. You can create a wide variety of components, including text blocks, charts, lists, and forms, and customise them with a variety of properties. This allows you to create a website that is tailored to your specific needs and requirements.' as contents, TRUE as break, 4 as size;
28+
SELECT 'In addition to its ease of use, SQLPage offers a wide range of features and capabilities. '||
29+
'You can create a wide variety of components, including text blocks, charts, lists, and forms, and customise them with a variety of properties. '||
30+
'This allows you to create a website that is tailored to your specific needs and requirements.' as contents, 4 as size;
1431

1532
select 'text' as component, 'Get started!' as title;
16-
SELECT 'Overall, SQLPage is a powerful and innovative tool for creating websites using only SQL. With its ease of use and wide range of features, it offers a unique and valuable way to create dynamic and functional websites without the need for complex programming languages. If you want to create a website with a database, SQLPage is the perfect tool for you.' as contents, TRUE as break, 4 as size;
33+
SELECT 'Overall, SQLPage is a powerful and innovative tool for creating websites using only SQL. With its ease of use and wide range of features, it offers a unique and valuable way to create dynamic and functional websites without the need for complex programming languages. If you want to create a website with a database, SQLPage is the perfect tool for you.' as contents, 4 as size;

examples/official-site/sqlpage/migrations/01_documentation.sql

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,10 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S
264264
('description', 'A description of the page. It can be displayed by search engines when your page appears in their results.', 'TEXT', TRUE, TRUE),
265265
('link', 'The target of the link in the top navigation bar.', 'URL', TRUE, TRUE),
266266
('image', 'The URL of an image to display next to the page title.', 'URL', TRUE, TRUE),
267-
('norobot', 'Forbid robots to save this page in their database and follow the links on this page. This will prevent this page to appear in Google search results for any query, for instance.', 'BOOLEAN', TRUE, TRUE)
267+
('icon', 'Name of an icon (from tabler-icons.io) to display next to the title in the navigation bar.', 'TEXT', TRUE, TRUE),
268+
('menu_item', 'Adds a menu item in the navigation bar at the top of the page. The menu item will have the specified name, and will link to as .sql file of the same name.', 'TEXT', TRUE, TRUE),
269+
('search_target', 'When this is set, a search field will appear in the top navigation bar, and load the specified sql file with an URL parameter named "search" when the user searches something.', 'TEXT', TRUE, TRUE),
270+
('norobot', 'Forbids robots to save this page in their database and follow the links on this page. This will prevent this page to appear in Google search results for any query, for instance.', 'BOOLEAN', TRUE, TRUE)
268271
);
269272

270273
INSERT INTO example(component, description, properties) VALUES

0 commit comments

Comments
 (0)