Skip to content

Commit 7a56419

Browse files
coopercooper
committed
update doc
1 parent 13b53b0 commit 7a56419

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+552
-72
lines changed

‎doc/technical/wiki.md

+46
Original file line numberDiff line numberDiff line change
@@ -686,6 +686,28 @@ func (w *Wiki) CategoryMap() map[string]CategoryInfo
686686
CategoryMap returns a map of model name to CategoryInfo for all models in the
687687
wiki.
688688

689+
#### func (*Wiki) CreateModel
690+
691+
```go
692+
func (w *Wiki) CreateModel(title string, content []byte, commit CommitOpts) (string, error)
693+
```
694+
CreateModel creates a new model file.
695+
696+
#### func (*Wiki) CreatePage
697+
698+
```go
699+
func (w *Wiki) CreatePage(where string, title string, content []byte, commit CommitOpts) (string, error)
700+
```
701+
CreatePage creates a new page file. If content is empty, a default page is
702+
created.
703+
704+
#### func (*Wiki) CreatePageFolder
705+
706+
```go
707+
func (w *Wiki) CreatePageFolder(where string, name string) error
708+
```
709+
CreatePageFolder creates a new page folder.
710+
689711
#### func (*Wiki) Debug
690712

691713
```go
@@ -920,6 +942,30 @@ func (w *Wiki) Pages() []wikifier.PageInfo
920942
```
921943
Pages returns info about all the pages in the wiki.
922944

945+
#### func (*Wiki) PagesAndDirs
946+
947+
```go
948+
func (w *Wiki) PagesAndDirs(where string) ([]wikifier.PageInfo, []string)
949+
```
950+
PagesAndDirs returns info about all the pages and directories in a directory.
951+
952+
#### func (*Wiki) PagesAndDirsSorted
953+
954+
```go
955+
func (w *Wiki) PagesAndDirsSorted(where string, descend bool, sorters ...SortFunc) ([]wikifier.PageInfo, []string)
956+
```
957+
PagesAndDirsSorted returns info about all the pages and directories in a
958+
directory, sorted as specified. Accepted sort functions are SortTitle,
959+
SortAuthor, SortCreated, and SortModified. Directories are always sorted
960+
alphabetically (but still respect the descend flag).
961+
962+
#### func (*Wiki) PagesInDir
963+
964+
```go
965+
func (w *Wiki) PagesInDir(where string) []wikifier.PageInfo
966+
```
967+
PagesInDir returns info about all the pages in the specified directory.
968+
923969
#### func (*Wiki) PagesSorted
924970

925971
```go

‎doc/technical/wikifier.md

+2
Original file line numberDiff line numberDiff line change
@@ -822,6 +822,8 @@ type PageInfo struct {
822822
Path string `json:"-"` // absolute filepath
823823
File string `json:"file,omitempty"` // name with extension, always with forward slashes
824824
FileNE string `json:"file_ne,omitempty"` // name without extension, always with forward slashes
825+
Base string `json:"base,omitempty"` // base name with extension
826+
BaseNE string `json:"base_ne,omitempty"` // base name without extension
825827
Created *time.Time `json:"created,omitempty"` // creation time
826828
Modified *time.Time `json:"modified,omitempty"` // modify time
827829
Draft bool `json:"draft,omitempty"` // true if page is marked as draft

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"file":"doc/blocks.cat","name":"doc/blocks","file_ne":"doc/blocks","created":"2025-02-23T10:03:06.940358-05:00","created_http":"Sun, 23 Feb 2025 15:03:06 GMT","modified":"2025-03-01T14:26:28.219925-05:00","modified_http":"Sat, 01 Mar 2025 19:26:28 GMT","pages":{"doc/configuration.md":{"asof":"2025-03-01T14:26:28.219925-05:00","file":"doc/configuration.md","file_ne":"doc/configuration","created":"2025-02-26T17:52:44.068575239-05:00","modified":"2025-02-26T17:52:44.068575239-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 root.ext external page.enable.title page.code.lang","lines":[275,288]},"doc/language.md":{"asof":"2025-02-23T10:03:06.940447-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":[50,51,210,214,629,137,137,167,167,168,220,357,358,474,503]},"doc/models.md":{"asof":"2025-02-23T10:03:07.195128-05:00","file":"doc/models.md","file_ne":"doc/models","created":"2025-02-23T09:41:58.236013272-05:00","modified":"2025-02-23T09:41:58.236013272-05:00","generated":true,"external":true,"fmt_title":"Models","title":"Models","author":"Markdown","preview":"Contents Models Creating models Using models Models Models are pieces of quiki source code that can be borrowed by multiple pages. This allows you to","warnings":[{"message":"No such code{} style 'monokailight' (from config)","position":[47,7]},{"message":"No such code{} style 'monokailight' (from config)","position":[63,7]}],"lines":[29,29]},"doc/technical/parsing.md":{"asof":"2025-02-23T10:03:07.08785-05:00","file":"doc/technical/parsing.md","file_ne":"doc/technical/parsing","created":"2025-02-23T09:41:58.239669833-05:00","modified":"2025-02-23T09:41:58.239669833-05:00","generated":true,"external":true,"fmt_title":"Parsing","title":"Parsing","author":"Markdown","preview":"Contents Parsing Parsing stages Master parser Parsing The quiki source language is parsed hierarchically. Parsing stages The parsing process is","lines":[26,28,29]},"main.page":{"asof":"2025-02-23T10:03:07.149321-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":[9]}},"preserve":true,"type":"page","page_info":{"file":"doc/blocks.md","file_ne":"doc/blocks","created":"2025-02-23T09:41:58.235478227-05:00","modified":"2025-02-23T09:41:58.235478227-05:00","generated":true,"external":true,"fmt_title":"Blocks","title":"Blocks","author":"Markdown","preview":"Contents Blocks clear{} code{} fmt{} map{} history{} html{} image{} imagebox{} infobox{} invisible{} list{} model{} olist{} p{} sec{} style{} Blocks"}}
1+
{"file":"doc/blocks.cat","name":"doc/blocks","file_ne":"doc/blocks","created":"2025-03-01T23:38:30.583651-05:00","created_http":"Sun, 02 Mar 2025 04:38:30 GMT","modified":"2025-03-01T23:38:30.756813-05:00","modified_http":"Sun, 02 Mar 2025 04:38:30 GMT","pages":{"doc/configuration.md":{"asof":"2025-03-01T23:38:30.58373-05:00","file":"doc/configuration.md","file_ne":"doc/configuration","base":"configuration.md","base_ne":"configuration","created":"2025-02-26T17:52:44.068575239-05:00","modified":"2025-02-26T17:52:44.068575239-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 root.ext external page.enable.title page.code.lang","lines":[275,288]},"doc/language.md":{"asof":"2025-03-01T23:38:30.686619-05:00","file":"doc/language.md","file_ne":"doc/language","base":"language.md","base_ne":"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","lines":[50,51,210,214,629,137,137,167,167,168,220,357,358,474,503]},"doc/models.md":{"asof":"2025-03-01T23:38:30.610194-05:00","file":"doc/models.md","file_ne":"doc/models","base":"models.md","base_ne":"models","created":"2025-02-23T09:41:58.236013272-05:00","modified":"2025-02-23T09:41:58.236013272-05:00","generated":true,"external":true,"fmt_title":"Models","title":"Models","author":"Markdown","preview":"Contents Models Creating models Using models Models Models are pieces of quiki source code that can be borrowed by multiple pages. This allows you to","lines":[29,29]},"doc/technical/parsing.md":{"asof":"2025-03-01T23:38:30.628969-05:00","file":"doc/technical/parsing.md","file_ne":"doc/technical/parsing","base":"parsing.md","base_ne":"parsing","created":"2025-02-23T09:41:58.239669833-05:00","modified":"2025-02-23T09:41:58.239669833-05:00","generated":true,"external":true,"fmt_title":"Parsing","title":"Parsing","author":"Markdown","preview":"Contents Parsing Parsing stages Master parser Parsing The quiki source language is parsed hierarchically. Parsing stages The parsing process is","lines":[26,28,29]},"main.page":{"asof":"2025-03-01T23:38:30.756813-05:00","file":"main.page","file_ne":"main","base":"main.page","base_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":[9]}},"preserve":true,"type":"page","page_info":{"file":"doc/blocks.md","file_ne":"doc/blocks","base":"blocks.md","base_ne":"blocks","created":"2025-02-23T09:41:58.235478227-05:00","modified":"2025-02-23T09:41:58.235478227-05:00","generated":true,"external":true,"fmt_title":"Blocks","title":"Blocks","author":"Markdown","preview":"Contents Blocks clear{} code{} fmt{} map{} history{} html{} image{} imagebox{} infobox{} invisible{} list{} model{} olist{} p{} sec{} style{} Blocks"}}

‎help-wiki/cache/meta/page/doc/configuration.cat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +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-26T17:52:44.068575239-05:00","modified":"2025-02-26T17:52:44.068575239-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 root.ext external page.enable.title page.code.lang"}}
1+
{"file":"doc/configuration.cat","name":"doc/configuration","file_ne":"doc/configuration","created":"2025-03-01T23:38:30.583-05:00","created_http":"Sun, 02 Mar 2025 04:38:30 GMT","modified":"2025-03-01T23:38:30.752967-05:00","modified_http":"Sun, 02 Mar 2025 04:38:30 GMT","pages":{"doc/language.md":{"asof":"2025-03-01T23:38:30.687674-05:00","file":"doc/language.md","file_ne":"doc/language","base":"language.md","base_ne":"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","lines":[619,681]},"main.page":{"asof":"2025-03-01T23:38:30.752967-05:00","file":"main.page","file_ne":"main","base":"main.page","base_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","base":"configuration.md","base_ne":"configuration","created":"2025-02-26T17:52:44.068575239-05:00","modified":"2025-02-26T17:52:44.068575239-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 root.ext external page.enable.title page.code.lang"}}

0 commit comments

Comments
 (0)