docs: Add new ignored words and files

The commit adds new ignored words and files
to improve spell checking accuracy.

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>

Author: ss-o

.github/.cspell/project-ignored.txt

@@ -1,20 +1,74 @@
+actlen
+addwin
 altmark
+assgn
 autoload
 bindkey
+bools
+BTAB
+builtins
+cidx
+circpath
 colorpair
+curx
+cvar
 datetime
+delwin
+dirpath
+elems
+ganchor
 ganchors
+hidx
+hpfx
+iidx
+isset
+lanchors
+lbox
 linerev
 lineund
 lzui
+midx
 nmap
 nohyp
+NONSELECTABLE
+nonselectables
+obal
+regen
+Regen
+SBUFFER
+segs
+sidx
+SIDX
+skeys
+slist
+stalog
 stdlib
+stext
+strftime
 syslib
+tfield
+THEWORD
+timestr
 unfunction
 usetty
 utillib
+varname
+xpos
+ypos
 zcurses
+zgen
+Zgen
 zmodload
 zstat
 zstyle
+zuiaction
+zuianchor
+zuianchoraglobal
+zuicheckbox
+zuieanchor
+zuiel
+zuiiaction
+zuilbox
+ZUILIST
+zuilog
+zuitfield

.github/.cspell/project-words.txt

@@ -1,4 +1,10 @@
+EPOCHSECONDS
 FPATH
+mbegin
 PMSPEC
+setopt
+subshell
+unsetopt
+zcompile
 Zshell
 ZSTYLES

docs/README.md

@@ -9,72 +9,82 @@
 
 ## ZUI – CGI+DHTML-like User Interface Library for Zsh / ZCurses
 
-This is a RAD (Rapid Application Development) textual user interface library for Zsh. It in many aspects resembles a typical CGI+(D)HTML setup. There are:
+This is a RAD (Rapid Application Development) textual user interface library for Zsh.
 
-- generators ran on the "server" side (basic Zshell-code that is just generating text!),
-- event loop that turns the generated text into a document with active elements (buttons, anchors, toggle buttons, text fields, list boxes),
-- mechanism to regenerate document parts from the original generators.
+It in many aspects resembles a typical CGI+(D)HTML setup. There are:
+
+- generators ran on the "server" side (basic Zshell code that is just generating text!)
+- event loop that turns the generated text into a document with active elements (buttons, anchors, toggle buttons, text fields, list boxes)
+- mechanism to regenerate document parts from the original generators
 
 So, a Zshell code generates text. It is then turned into a document with hyperlinks. DHTML-like calls are possible that will regenerate document parts on the fly. Page can be also reloaded with input data, just like an HTML page.
 
 A voiced [video tutorial](https://youtu.be/TfZ8b_RS_Bg) shows how to create an application – Nmap network scanner frontend.
 
-> See also [ZSTYLES](ZSTYLES.md)
+> More: [zstyles](ZSTYLES.md), [demos](https://github.com/z-shell/zui/blob/main/demos/zui-demo-list-boxes)
+
+The API is described in the [wiki](https://wiki.zshell.dev/ecosystem/plugins/zui).
 
 ## Hello World
 
+Enable demo functions before loading the plugin:
+
 ```zsh
-# Started from Zle or from command line
+typeset -A ZUI
+ZUI[DEMOS]=1
+```
 
+Started from Zle or the command line:
+
+```zsh
 -zui_std_cleanup deserialize:"zui-demo-hello-world"
 -zui_std_init app:"zui-demo-hello-world" app_name:"ZUI Hello World"
-emulate -LR zsh -o extended_glob -o typeset_silent -o warn_create_global
--zui_std_init2 # after emulate -LR
 
+emulate -LR zsh
+setopt extended_glob typeset_silent warn_create_global
+
+-zui_std_init2 # after emulate -LR
 -zui_std_store_default_app_config b:border 1
 
 demo_generator_A() {
-    local mod="$1" ice="$2"
-    # Content, no hyper-links
-    reply=( "Hello World from ${ZUI[YELLOW]}ZUI${ZUI[FMT_END]}! Module $mod, instance $ice." )
-    # Non-selectable lines   Hops to jump with [ and ]   Local anchors
-    reply2=( )               reply3=( 1 )                reply4=( )
+  local mod="$1" ice="$2"
+  # Content, no hyper-links
+  reply=( "Hello World from ${ZUI[YELLOW]}ZUI${ZUI[FMT_END]}! Module $mod, instance $ice." )
+  # Non-selectable lines   Hops to jump with [ and ]   Local anchors
+  reply2=( )               reply3=( 1 )                reply4=( )
 }
+```
 
-## Start application ##
+Start application:
+
+```zsh
 zui-event-loop 1:demo_generator_A
 
 -zui_std_cleanup serialize
 ```
 
-Other example which uses list-box: [zui-demo-list-box](https://github.com/z-shell/zui/blob/main/demos/zui-demo-list-boxes)
-
-The API is described in the [wiki](https://wiki.zshell.dev/ecosystem/plugins/zui).
-
 ## Installation
 
-**The plugin is "standalone"**, which means that only sourcing it is needed. To install, unpack `zui` somewhere and add to `zshrc`:
+**The plugin is "standalone"**, which means that only sourcing it is needed. To install, unpack <samp>zui</samp> and load from <samp>.zshrc</samp>:
 
 ```zsh
 source {where-zui-is}/zui.plugin.zsh
 ```
 
-If using a plugin manager, then `Zi` is recommended, but you can use any other too, and also install with `Oh My Zsh` (by copying the directory to `~`/.oh-my-zsh/custom/plugins`).
-
 ### [Zi](https://github.com/z-shell/zi)
 
-Add `zi load z-shell/zui` to your `.zshrc` file. ZI will handle the rest automatically the next time you start zsh. To update (i.e. to pull from origin) issue `zi update z-shell/zui`.
+Add <samp>zi load z-shell/zui</samp> to your <samp>.zshrc</samp> file. ZI will handle the rest automatically the next time you start zsh. To update (i.e. to pull from origin) issue <samp>zi update z-shell/zui</samp>.
 
 ### Antigen
 
-Add `antigen bundle z-shell/zui` to your `.zshrc` file. Antigen will handle cloning the plugin for you automatically the next time you start zsh.
+Add <samp>antigen bundle z-shell/zui</samp> to your <samp>.zshrc</samp> file. Antigen will handle cloning the plugin for you automatically the next time you start zsh.
 
 ### Oh-My-Zsh
 
-1. `cd ~/.oh-my-zsh/custom/plugins`
-2. `git clone git@github.com:z-shell/zui.git`
-3. Add `zui` to your plugin list
+1. <samp>cd ~/.oh-my-zsh/custom/plugins</samp>
+2. <samp>git clone https://github.com/z-shell/zui.git</samp>
+3. Add <samp>zui</samp> to your plugin list
 
 ### Zgen
 
-Add `zgen load z-shell/zui` to your .zshrc file in the same place you're doing your other `zgen load` calls in.
+Add <samp>zgen load z-shell/zui</samp> to your .zshrc file in the same place you're doing your other <samp>zgen load</samp> calls in.