Improve documentation.

FossilOrigin-Name: 2a86e1d68c59362f290674bd0a5466aa6f2e8e9e355b6d7215ed4159ce355f76
programandala-net · Sep 5, 2022 · f316f40 · f316f40
1 parent 7582d13
commit f316f40
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/VERSION.fs b/VERSION.fs
@@ -3,6 +3,6 @@
 \ This file is part of Fendo
 \ (http://programandala.net/en.program.fendo.html).
 
-: fendo_version ( -- ca len ) s" 0.6.0-pre.85+20220905T1048CEST" ;
+: fendo_version ( -- ca len ) s" 0.6.0-pre.86+20220905T1209CEST" ;
 
 \ vim: filetype=gforth
diff --git a/fendo.markup.fendo.link.fs b/fendo.markup.fendo.link.fs
@@ -5,7 +5,7 @@
 
 \ This file defines the Fendo markup for links.
 
-\ Last modified  20220905T1044+0200.
+\ Last modified  20220905T1209+0200.
 \ See change log at the end of the file.
 
 \ Copyright (C) 2013, 2014, 2015, 2017, 2018, 2020, 2021, 2022 Marcos
@@ -214,13 +214,15 @@ variable [[-depth
   \ Usage examples:
 
   \ ----
+  \ simple_[[ \ select the simple link markup
   \ [[ "http://programandala.net" ]]
   \ [[ "http://programandala.net/en.program.fendo.html"
   \    "Fendo homepage" ]]
   \ [[ "http://programandala.net/en.program.fendo.html" "Fendo"
   \    title=" Fendo home page" ]]
   \ [[ s" This is the title" title=!
   \    "http://programandala.net" ]]
+  \ complex_[[ \ return to the default format
   \ ----
 
   \ The text in the markup is evaluated as Forth code. The first
@@ -230,6 +232,10 @@ variable [[-depth
   \ ``style="``, etc., in any order or position. Also their storage
   \ variants like ``title=!`` are valid.
   \
+  \ WARNING: The text "]]", delimited by spaces or end of lines,
+  \ cannot be part of the link text or any attribute. Otherwise it
+  \ would be mistaken for the ending `]]`.
+  \
   \ See also: `(simple_]])`, `(complex_[[)`, `link`, `shortcut:`.
   \
   \ }doc
@@ -361,6 +367,6 @@ complex_[[ \ set the default
 \
 \ 2021-10-23: Improve documentation.
 \
-\ 2022-09-05: Fix typos in documentation.
+\ 2022-09-05: Fix and improve the documentation.
 
 \ vim: filetype=gforth