update docs

Author: cooper

build

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ "$1" == "gendoc" ]; then
+if [ "$1" == "doc" ]; then
     for d in */; do
         d=${d::${#d}-1}
         count=`ls -1 $d/*.go 2>/dev/null | wc -l`
@@ -14,6 +14,6 @@ elif [ "$1" == "help" ]; then
 elif [ "$1" == "test" ]; then
     ./quiki -wiki=test -force-gen
 else
-    echo "Usage: $0 {gendoc|help|test}"
+    echo "Usage: $0 {doc|help|test}"
     exit 1
 fi

doc/technical/wikifier.md

@@ -163,27 +163,96 @@ func NewList(mb block) *List
 NewList creates a new list, given the main block of the page it is to be
 associated with.
 
-#### func (List) Fmt
+#### func (List) Get
 
 ```go
-func (b List) Fmt(text string, pos Position) HTML
+func (scope List) Get(key string) (any, error)
 ```
-Fmt generates HTML from a quiki-encoded formatted string.
+Get fetches a a value regardless of type.
+
+The key may be segmented to indicate properties of each object (e.g.
+person.name).
+
+If attempting to read a property of an object that does not support properties,
+such as a string, Get returns an error.
+
+If the key is valid but nothing exists at it, Get returns (nil, nil).
+
+#### func (List) GetBlock
+
+```go
+func (scope List) GetBlock(key string) (block, error)
+```
+GetBlock is like Get except it always returns a block.
+
+#### func (List) GetBool
+
+```go
+func (scope List) GetBool(key string) (bool, error)
+```
+GetBool is like Get except it always returns a boolean.
+
+#### func (List) GetObj
+
+```go
+func (scope List) GetObj(key string) (AttributedObject, error)
+```
+GetObj is like Get except it always returns an AttributedObject.
+
+#### func (List) GetStr
+
+```go
+func (scope List) GetStr(key string) (string, error)
+```
+GetStr is like Get except it always returns a string.
+
+If the value is HTML, it is converted to a string.
+
+#### func (List) GetStrList
+
+```go
+func (scope List) GetStrList(key string) ([]string, error)
+```
+GetStrList is like Get except it always returns a list of strings.
 
-#### func (List) FmtOpts
+If the value is a `list{}` block, the list's values are returned, with
+non-strings quietly filtered out.
+
+If the value is a string, it is treated as a comma-separated list, and each item
+is trimmed of prepending or suffixing whitespace.
+
+#### func (List) Set
 
 ```go
-func (b List) FmtOpts(text string, pos Position, o FmtOpt) HTML
+func (scope List) Set(key string, value any) error
 ```
-FmtOpts is like Fmt except you can specify additional options with the FmtOpt
-argument.
+Set sets a value at the given key.
+
+The key may be segmented to indicate properties of each object (e.g.
+person.name).
+
+If attempting to write to a property of an object that does not support
+properties, such as a string, Set returns an error.
 
 #### func (List) String
 
 ```go
 func (b List) String() string
 ```
 
+#### func (List) Unset
+
+```go
+func (scope List) Unset(key string) error
+```
+Unset removes a value at the given key.
+
+The key may be segmented to indicate properties of each object (e.g.
+person.name).
+
+If attempting to unset a property of an object that does not support properties,
+such as a string, Unset returns an error.
+
 #### type Map
 
 ```go
@@ -202,21 +271,6 @@ func NewMap(mb block) *Map
 NewMap creates a new map, given the main block of the page it is to be
 associated with.
 
-#### func (Map) Fmt
-
-```go
-func (b Map) Fmt(text string, pos Position) HTML
-```
-Fmt generates HTML from a quiki-encoded formatted string.
-
-#### func (Map) FmtOpts
-
-```go
-func (b Map) FmtOpts(text string, pos Position, o FmtOpt) HTML
-```
-FmtOpts is like Fmt except you can specify additional options with the FmtOpt
-argument.
-
 #### func (Map) Get
 
 ```go

help-wiki/cache/meta/page/doc/blocks.cat

@@ -1 +1 @@
-{"file":"doc/configuration.cat","name":"doc/configuration","file_ne":"doc/configuration","created":"2025-02-23T10:03:06.941006-05:00","created_http":"Sun, 23 Feb 2025 15:03:06 GMT","modified":"2025-02-23T10:03:07.16111-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","pages":{"doc/language.md":{"asof":"2025-02-23T10:03:06.941099-05:00","file":"doc/language.md","file_ne":"doc/language","created":"2025-02-23T09:41:58.234670181-05:00","modified":"2025-02-23T09:41:58.234670181-05:00","generated":true,"external":true,"fmt_title":"Language","title":"Language","author":"Markdown","preview":"Contents Language Syntax Comments Escapes Blocks Nameless blocks Named blocks Block type inference Model shorthand Data types Variables Assignment","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[15,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[59,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[67,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[174,20]},{"message":"No such code{} style 'monokailight' (from config)","position":[203,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[228,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[238,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[258,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[268,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[286,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[298,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[330,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[346,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[381,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[390,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[399,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[415,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[425,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[436,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[448,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[467,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[483,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[507,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[531,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[553,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[567,7]}],"lines":[619,681]},"main.page":{"asof":"2025-02-23T10:03:07.16111-05:00","file":"main.page","file_ne":"main","created":"2020-03-29T22:23:32Z","modified":"2025-02-23T09:41:53.584630772-05:00","fmt_title":"Help","title":"Help","author":"quiki authors","preview":"Documentation Language spec Configuration spec Block reference Models (Templating) Styling (CSS) Additional help quiki website Report a bug or issue","lines":[8]}},"preserve":true,"type":"page","page_info":{"file":"doc/configuration.md","file_ne":"doc/configuration","created":"2025-02-23T09:41:58.236688692-05:00","modified":"2025-02-23T09:41:58.236688692-05:00","generated":true,"external":true,"fmt_title":"Configuration","title":"Configuration","author":"Markdown","preview":"Contents Configuration Configuration files wikifier options name host.wiki dir.wiki root external page.enable.title page.code.lang page.code.style","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[22,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[149,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[216,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[228,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[245,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[398,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[448,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[486,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[495,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[519,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[535,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[555,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[579,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[591,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[613,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[633,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[651,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[708,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[723,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[731,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[747,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[823,7]}]}}
+{"file":"doc/configuration.cat","name":"doc/configuration","file_ne":"doc/configuration","created":"2025-02-23T10:03:06.941006-05:00","created_http":"Sun, 23 Feb 2025 15:03:06 GMT","modified":"2025-02-23T10:03:07.16111-05:00","modified_http":"Sun, 23 Feb 2025 15:03:07 GMT","pages":{"doc/language.md":{"asof":"2025-02-23T10:03:06.941099-05:00","file":"doc/language.md","file_ne":"doc/language","created":"2025-02-23T09:41:58.234670181-05:00","modified":"2025-02-23T09:41:58.234670181-05:00","generated":true,"external":true,"fmt_title":"Language","title":"Language","author":"Markdown","preview":"Contents Language Syntax Comments Escapes Blocks Nameless blocks Named blocks Block type inference Model shorthand Data types Variables Assignment","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[15,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[59,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[67,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[174,20]},{"message":"No such code{} style 'monokailight' (from config)","position":[203,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[228,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[238,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[258,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[268,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[286,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[298,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[330,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[346,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[381,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[390,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[399,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[415,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[425,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[436,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[448,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[467,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[483,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[507,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[531,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[553,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[567,7]}],"lines":[619,681]},"main.page":{"asof":"2025-02-23T10:03:07.16111-05:00","file":"main.page","file_ne":"main","created":"2020-03-29T22:23:32Z","modified":"2025-02-23T09:41:53.584630772-05:00","fmt_title":"Help","title":"Help","author":"quiki authors","preview":"Documentation Language spec Configuration spec Block reference Models (Templating) Styling (CSS) Additional help quiki website Report a bug or issue","lines":[8]}},"preserve":true,"type":"page","page_info":{"file":"doc/configuration.md","file_ne":"doc/configuration","created":"2025-02-23T09:41:58.236688692-05:00","modified":"2025-02-23T09:41:58.236688692-05:00","generated":true,"external":true,"fmt_title":"Configuration","title":"Configuration","author":"Markdown","preview":"Contents Configuration Configuration files wikifier options name host.wiki dir.wiki root external page.enable.title page.code.lang page.code.style"}}