x.templating.dtm: fix formatting and improve clarity in README.md (#25966)

StunxFS · web-flow · commit dc0b0f50bf36 · 2025-12-14T17:01:31.000+02:00
diff --git a/vlib/x/templating/dtm/README.md b/vlib/x/templating/dtm/README.md
@@ -5,17 +5,17 @@ templates with Vweb, without the need to recompile the application with every ch
 
 ## Quick Start
 
-Using the dynamic template manager ( named '**dtm**' in this readme) is relatively straightforward.
-You just need to initialize an instance. Then, call the '**expand**' function in the code that
+Using the dynamic template manager (named `dtm` in this readme) is relatively straightforward.
+You just need to initialize an instance. Then, call the `expand` function in the code that
 manages your template.
 
-Before starting, You can specify a folder, but it is not mandatory to store the generated cache. If
+Before starting, you can specify a folder, but it is not mandatory to store the generated cache. If
 nothing is specified or if there is a problem with the targeted folder (for example, a permission
 issue), the DTM will attempt to create a cache folder in the temporary file area of your OS.
 Finally, if all this does not prove successful, then the DTM will disable the cache system and
 notify the user if the cache system was previously required.
 
-However, at the root directory of your project, you need to create a '**templates**' folder. The
+However, at the root directory of your project, you need to create a `templates/` folder. The
 absence of these directories will prevent you from using the dtm. You must add your template files
 into the folder you previously created. ***Be aware that if the templates are not placed in the
 correct directory, the DTM will return an error message indicating that it cannot find the
@@ -51,12 +51,12 @@ fn main() {
 }
 ```
 
-#### and its template text format :
+#### and its template text format:
 
 ```
-Title of text : @title
-Value in the text : @non_string_type
-HTML tags are always escaped in text file : @html_section
+Title of text: @title
+Value in the text: @non_string_type
+HTML tags are always escaped in text file: @html_section
 ```
 
 ### 2. Minimal Vweb example:
@@ -85,16 +85,14 @@ fn main() {
 		app.dtmi.stop_cache_handler()
 	}
 
-	/*
-    Here is an example of init configuration :
+	// Here is an example of init configuration:
 
 	dtm.initialize(
-      def_cache_path: cache_folder_path
-	  compress_html: false
-	  active_cache_server: false
-	  max_size_data_in_mem: 100
-    )
-	*/
+		def_cache_path:       cache_folder_path
+		compress_html:        false
+		active_cache_server:  false
+		max_size_data_in_mem: 100
+	)
 
 	veb.run[App, Context](mut app, 18081)
 }
@@ -108,7 +106,7 @@ pub fn (mut app App) index(mut ctx Context) veb.Result {
 }
 ```
 
-#### and its template html format :
+#### and its template html format:
 
 ```html
 <!doctype html>
@@ -138,18 +136,18 @@ There are two types of option possibilities:
 
 Three parameters are available:
 
-- `def_cache_path` : ( **String** value ) User can define the path of cache folder.
-- `max_size_data_in_mem` : ( **Int** value ) Maximum size of data allowed in memory for each cached
-  template. The value must be specified in kilobytes. ( Default is: 500KB / Limit max is : 500KB )
-- `compress_html` : ( **Bool** value ) Light '**minifier**' of the HTML output, to remove all
-unnecessary spacing. ( Default is true, parameter taken into account only for HTML files )
-- `active_cache_server` : ( **Bool** value ) Activate or not the template cache system. ( Default
-  is true, ***_Highly recommended to keep it enabled for optimal performance_*** )
+- `def_cache_path` (**string** value): User can define the path of cache folder.
+- `max_size_data_in_mem` (**int** value): Maximum size of data allowed in memory for each cached.
+  template. The value must be specified in kilobytes (default is: 500KB; limit max is: 500KB).
+- `compress_html` (**bool** value): Light **minifier** of the HTML output, to remove all
+unnecessary spacing (default is `true`, parameter taken into account only for HTML files).
+- `active_cache_server` (**bool** value): Activate or not the template cache system (default
+  is true, ***_highly recommended to keep it enabled for optimal performance_***).
 
 Regarding the `compress_html` option, it is recommended for performance reasons to disable it
 when working directly with raw template generation (i.e., with the cache system disabled).
 
-Use it like this :
+Use it like this:
 
 ```v ignore
 initialize(
@@ -162,30 +160,30 @@ initialize(
 
 ### Defined for each call of expand function
 
-- `placeholders` ( **&map[string]DtmMultiTypeMap** value ) Used to map placeholders within the
+- `placeholders` (**&map[string]DtmMultiTypeMap** value): Used to map placeholders within the
   template to their corresponding content, facilitating dynamic content insertion, by specifying
   values in the placeholders map. Templates can dynamically display content.
 
-- `cache_delay_expiration` ( **i64** value ) Specifies the cache expiration time for the concerned
-  page in seconds. ( Default value is **86400** seconds or one day ). You can add any value you
-  want in seconds as long as it remains within the indicated range ( see below ).
+- `cache_delay_expiration` (**i64** value): Specifies the cache expiration time for the concerned
+  page in seconds (default value is `86400` seconds or one day). You can add any value you
+  want in seconds as long as it remains within the indicated range (see below).
 
 Possibility to use already defined cache delay constants like:
 
-- `cache_delay_expiration_at_min` : five minutes
-- `cache_delay_expiration_at_max` : one year
-- `cache_delay_expiration_by_default` : one day
+- `cache_delay_expiration_at_min`: five minutes.
+- `cache_delay_expiration_at_max`: one year.
+- `cache_delay_expiration_by_default`: one day.
 
 For specific cases, you can cancel the generation and use of cache file, even if the cache system
-is active :
+is active:
 
-- `cache_delay_expiration` : -1
+- `cache_delay_expiration: -1`.
 
 Or set a cache that will never expire:
 
-- `cache_delay_expiration` : 0
+- `cache_delay_expiration: 0`.
 
-Example :
+Example:
 
 ```v ignore
 expand('path/of/template.html',
@@ -196,7 +194,7 @@ expand('path/of/template.html',
 
 ## The PlaceHolders System
 
-### On The User's Side Code :
+### On The User's Side Code:
 
 The placeholder system allows for the insertion of dynamic content into your template. As of the
 current state of the module, it accepts the following types like:
@@ -221,7 +219,7 @@ expand('path/of/template.html',
 )
 ```
 
-Pay attention to this particular tag: "**_#includehtml**", it enables you to include HTML in the
+Pay attention to this particular tag: `_#includehtml`, it enables you to include HTML in the
 dynamic content. Without this tag, all characters will be escaped for obvious security reasons. By
 using this tag, only certain HTML tags are allowed. Here is the list:
 
@@ -239,7 +237,7 @@ using this tag, only certain HTML tags are allowed. Here is the list:
 
 #### Note that with a raw text template, all HTML tag inclusions are escaped.
 
-### On The Template Side :
+### On The Template Side:
 
 An example of a template, corresponding to the previous subsection:
 
@@ -259,13 +257,13 @@ An example of a template, corresponding to the previous subsection:
 </html>
 ```
 
-You will note that the `'_#includehtml'` directive is not found in the template with
-`'@placeholder_name_3'`, and this is entirely normal. Directives are specially handled by the DTM,
-and including them in the name of your placeholders within the template will result in the
-placeholder not being found because it does not match the key name defined in the map containing
-the dynamic content.
+You will note that the `_#includehtml` directive is not found in the template with
+`@placeholder_name_3`, and this is entirely normal. Directives are specially handled
+by the DTM, and including them in the name of your placeholders within the template
+will result in the placeholder not being found because it does not match the key name
+defined in the map containing the dynamic content.
 
-Like the traditional template system in V, inclusions or placeholders start with the '**@**'
+Like the traditional template system in V, inclusions or placeholders start with the `@`
 character. The traditional inclusion system is still perfectly usable, such as:
 
 ```
