From d5e6e5d81d2ca2758b9bec3e819640831ace65ff Mon Sep 17 00:00:00 2001 From: Thomas Lange Date: Thu, 21 Nov 2024 21:42:20 +0100 Subject: Update documentation --- Content_tags.md | 16 ++++++++-------- Editor.md | 6 +++--- Templates.md | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Content_tags.md b/Content_tags.md index d526095..e95e5cd 100644 --- a/Content_tags.md +++ b/Content_tags.md @@ -5,13 +5,13 @@ This means that users who are still using the old syntax in their entities' cont ## List of old content tags This table contains all hardcoded *content tags* that existed. -| Tag | Description | Parameters | -|--------|-----------------------------------------------|-----------------| -| `BASE` | Return pure URL relative to root directory. | `(string) path` | -| `FILE` | Return pure URL relative to `rsrc` directory. | `(string) path` | -| `PAGE` | Return pure URL to a **page** entity. | `(int) id` | -| `POST` | Return pure URL to a **post** entity. | `(int) id` | -| `USER` | Return pure URL to a **user** entity. | `(int) id` | +| Tag | Description | Parameters | +|--------|-------------------------------------------------|-----------------| +| `BASE` | Return pure URL relative to root directory. | `(string) path` | +| `FILE` | Return pure URL relative to `static` directory. | `(string) path` | +| `PAGE` | Return pure URL to a **page** entity. | `(int) id` | +| `POST` | Return pure URL to a **post** entity. | `(int) id` | +| `USER` | Return pure URL to a **user** entity. | `(int) id` | ## Usage examples ~~~md @@ -32,7 +32,7 @@ Hello. Check out [my new post](https://hostname/post/new-post/)! ~~~ ~~~md -![A cute kitten](https://hostname/rsrc/images/cats/kitten.jpg) +![A cute kitten](https://hostname/static/images/cats/kitten.jpg) ~~~ ~~~md diff --git a/Editor.md b/Editor.md index dd53b4b..fcec277 100644 --- a/Editor.md +++ b/Editor.md @@ -3,7 +3,7 @@ If you want to reference another item (e.g. a post or a category) in your conten **Note:** You can combine these functions with Markdown syntax since they are processed and transformed before the Markdown parser finally transforms the content to HTML. There is even the possibility [to add your own custom functions](Content_Functions#how-to-add-custom-functions). ## Relative URLs -You can link any resource (e.g. a file) which is located anywhere within your document root dynamically, either relative to your base directory (the installation directory) or relative to the `rsrc` directory where you store your files, images and other stuff. The `BASE_URL` and `FILE_URL` functions will return the pure plain text URL (extended by the first argument). +You can link any resource (e.g. a file) which is located anywhere within your document root dynamically, either relative to your base directory (the installation directory) or relative to the `static` directory where you store your files, images and other stuff. The `BASE_URL` and `FILE_URL` functions will return the pure plain text URL (extended by the first argument). ### Example #1 ~~~markdown @@ -24,11 +24,11 @@ Hello there. Check out the README! ~~~ ~~~markdown -![A cute kitten](https://blog.git/rsrc/image/content/kitten.jpg "Look at this!") +![A cute kitten](https://blog.git/static/image/content/kitten.jpg "Look at this!") ~~~ ~~~html -A cute kitten +A cute kitten ~~~ ## Linking items in your content (categories, pages, posts and users) diff --git a/Templates.md b/Templates.md index 4a5bdc1..e94c41d 100644 --- a/Templates.md +++ b/Templates.md @@ -32,7 +32,7 @@ │   ├── de.php │   └── en.php │   └── […] - └── rsrc + └── static └── […] ## Global `html/*` -- cgit v1.2.3