urbit/developers.urbit.org
1
1
Fork 0
mirror of https://github.com/urbit/developers.urbit.org.git synced 2024-09-11 13:55:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #216 from urbit/mop-docs

Browse Source 
add mop reference
This commit is contained in:
tinnus-napbus 2022-11-10 17:11:12 +13:00 committed by GitHub
commit ed9e8d4fac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 1377 additions and 256 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/guides/additional/json-guide.md
View File

@ -499,7 +499,7 @@ Usually (though not in all cases) these mark conversions will be performed impli
## Further reading
[The Zuse library reference](/reference/hoon/zuse/table-of-contents) - This includes documentation of the JSON parsing, printing, encoding and decoding functions.
[The Zuse library reference](/reference/hoon/zuse) - This includes documentation of the JSON parsing, printing, encoding and decoding functions.
[The Marks section of the Clay documentation](/reference/arvo/clay/marks/marks) - Comprehensive documentation of `mark`s.

6
content/guides/core/app-school-full-stack/3-json.md
View File

@ -9,7 +9,7 @@ to convert our agent's structures to and from JSON for our front-end.
JSON data comes into Eyre as a string, and Eyre parses it with the
[`++de-json:html`](/reference/hoon/zuse/2e_2-3#de-jsonhtml) function in
[`zuse.hoon`](/reference/hoon/zuse/table-of-contents). The
[`zuse.hoon`](/reference/hoon/zuse). The
hoon type it's parsed to is `$json`, which is defined as:
```hoon
@ -48,7 +48,7 @@ we'll write a library called `/lib/journal.hoon` with the conversion functions.
## `$json` utilities
[`zuse.hoon`](/reference/hoon/zuse/table-of-contents) contains three main
[`zuse.hoon`](/reference/hoon/zuse) contains three main
cores for converting to and from `$json`:
- [`++enjs:format`](/reference/hoon/zuse/2d_1-5#enjsformat) - Functions to
@ -342,7 +342,7 @@ when you write `$json` encoding functions, and is the reason there are far fewer
- [The JSON Guide](/guides/additional/json-guide) - The stand-alone JSON guide
covers JSON encoding/decoding in great detail.
- [The Zuse reference](/reference/hoon/zuse/table-of-contents) - The
- [The Zuse reference](/reference/hoon/zuse) - The
`zuse.hoon` reference documents all JSON-related functions in detail.
- [`++enjs:format` reference](/reference/hoon/zuse/2d_1-5#enjsformat) -

2
content/guides/core/app-school-full-stack/9-final.md
View File

@ -56,7 +56,7 @@ Here is the reference material for each section of this walkthrough.
- [The JSON Guide](/guides/additional/json-guide) - The stand-alone JSON guide
covers JSON encoding/decoding in great detail.
- [The Zuse Reference](/reference/hoon/zuse/table-of-contents) - The
- [The Zuse Reference](/reference/hoon/zuse) - The
`zuse.hoon` reference documents all JSON-related functions in detail.
- [`++enjs:format` reference](/reference/hoon/zuse/2d_1-5#enjsformat) -

2
content/guides/core/app-school/12-next-steps.md
View File

@ -22,7 +22,7 @@ following documents for help writing a web front-end for your app:
- [JSON guide](/guides/additional/json-guide) - This walks through the basics of
converting Hoon data structures to JSON, for use with a web client. It also
covers JSON conversion methods in `mark` files.
- [Zuse reference](/reference/hoon/zuse/table-of-contents) - This contains
- [Zuse reference](/reference/hoon/zuse) - This contains
documentation of all JSON encoding and decoding functions included in the
`zuse.hoon` utility library.
- [The software distribution guide](/guides/additional/software-distribution) - This covers

2
content/reference/arvo/reference/filesystem.md
View File

@ -73,7 +73,7 @@ just depend on `%base`. The chain of dependencies is `hoon.hoon` -> `arvo.hoon`
[cryptography](/reference/arvo/reference/cryptography). `zuse.hoon` is loaded by
the larval kernel following `lull.hoon`. `lull.hoon` is the subject of
`zuse.hoon`. Then `zuse` is the subject of the vanes. Some of the functions in
Zuse are documented [here](/reference/hoon/zuse/table-of-contents).
Zuse are documented [here](/reference/hoon/zuse).
## Desks

2
content/reference/glossary/zuse.md
View File

@ -20,6 +20,6 @@ so its version number is used to represent the version of the kernel as a whole.
### Further Reading
- [Zuse reference](/reference/hoon/zuse/table-of-contents): Developer
- [Zuse reference](/reference/hoon/zuse): Developer
documentation of various functions in `zuse.hoon`, particularly those relating
to JSON.

1365
content/reference/hoon/zuse/2m.md Normal file
View File

File diff suppressed because it is too large Load Diff

6
content/reference/hoon/zuse/_index.md
View File

@ -7,8 +7,6 @@ insert_anchor_links = "right"
Documentation for the `zuse.hoon` library.
[Table of Contents](/reference/hoon/zuse/table-of-contents)
### 2d: Formatting functions
[2d(1-5): To JSON, Wains](/reference/hoon/zuse/2d_1-5)
@ -28,3 +26,7 @@ Functions for decoding `json` to `unit`s.
[2e(2-3): Print & Parse JSON](/reference/hoon/zuse/2e_2-3)
Print `json` and parse JSON.
### 2m: Ordered Maps
[2m: Ordered Maps](/reference/hoon/zuse/2m)

246
content/reference/hoon/zuse/table-of-contents.md
View File

@ -1,246 +0,0 @@
+++
title = "Table of Contents"
weight = 0
sort_by = "weight"
+++
Documentation for the Zuse library.
Can be navigated [alphabetically](#alphabetical) or [by section](#by-section).
## Alphabetical
### a
[`++ar:dejs-soft:format`](/reference/hoon/zuse/2d_7/#ardejs-softformat)
[`++ar:dejs:format`](/reference/hoon/zuse/2d_6/#ardejsformat)
[`++as:dejs:format`](/reference/hoon/zuse/2d_6/#asdejsformat)
[`++at-raw:dejs-soft:format`](/reference/hoon/zuse/2d_7/#at-rawdejs-softformat)
[`++at-raw:dejs:format`](/reference/hoon/zuse/2d_6/#at-rawdejsformat)
[`++at:dejs-soft:format`](/reference/hoon/zuse/2d_7/#atdejs-softformat)
[`++at:dejs:format`](/reference/hoon/zuse/2d_6/#atdejsformat)
### b
[`++bo:dejs-soft:format`](/reference/hoon/zuse/2d_7/#bodejs-softformat)
[`++bo:dejs:format`](/reference/hoon/zuse/2d_6/#bodejsformat)
[`++bu:dejs-soft:format`](/reference/hoon/zuse/2d_7/#budejs-softformat)
[`++bu:dejs:format`](/reference/hoon/zuse/2d_6/#budejsformat)
### c
[`++ci:dejs-soft:format`](/reference/hoon/zuse/2d_7/#cidejs-softformat)
[`++ci:dejs:format`](/reference/hoon/zuse/2d_6/#cidejsformat)
[`++cu:dejs-soft:format`](/reference/hoon/zuse/2d_7/#cudejs-softformat)
[`++cu:dejs:format`](/reference/hoon/zuse/2d_6/#cudejsformat)
### d
[`++da:dejs-soft:format`](/reference/hoon/zuse/2d_7/#dadejs-softformat)
[`++dank:dejs-soft:format`](/reference/hoon/zuse/2d_7/#dankdejs-softformat)
[`++dejs-soft:format`](/reference/hoon/zuse/2d_7/#dejs-softformat)
[`++dejs:format`](/reference/hoon/zuse/2d_6/#dejsformat)
[`++de-json:html`](/reference/hoon/zuse/2e_2-3/#de-jsonhtml)
[`++di:dejs-soft:format`](/reference/hoon/zuse/2d_7/#didejs-softformat)
[`++di:dejs:format`](/reference/hoon/zuse/2d_6/#didejsformat)
[`++du:dejs:format`](/reference/hoon/zuse/2d_6/#dudejsformat)
### e
[`++en-json:html`](/reference/hoon/zuse/2e_2-3/#en-jsonhtml)
[`++enjs:format`](/reference/hoon/zuse/2d_1-5/#enjsformat)
### f
[`++frond:enjs:format`](/reference/hoon/zuse/2d_1-5/#frondenjsformat)
### j
[`++json-rn:format`](/reference/hoon/zuse/2d_1-5/#json-rnformat)
### m
[`++mu:dejs-soft:format`](/reference/hoon/zuse/2d_7/#mudejs-softformat)
[`++mu:dejs:format`](/reference/hoon/zuse/2d_6/#mudejsformat)
### n
[`++ne:dejs-soft:format`](/reference/hoon/zuse/2d_7/#nedejs-softformat)
[`++ne:dejs:format`](/reference/hoon/zuse/2d_6/#nedejsformat)
[`++ni:dejs-soft:format`](/reference/hoon/zuse/2d_7/#nidejs-softformat)
[`++ni:dejs:format`](/reference/hoon/zuse/2d_6/#nidejsformat)
[`++no:dejs-soft:format`](/reference/hoon/zuse/2d_7/#nodejs-softformat)
[`++no:dejs:format`](/reference/hoon/zuse/2d_6/#nodejsformat)
[`++nu:dejs:format`](/reference/hoon/zuse/2d_6/#nudejsformat)
[`++numb:enjs:format`](/reference/hoon/zuse/2d_1-5/#numbenjsformat)
### o
[`++of-wain:format`](/reference/hoon/zuse/2d_1-5/#of-wainformat)
[`++of-wall:format`](/reference/hoon/zuse/2d_1-5/#of-wallformat)
[`++of:dejs-soft:format`](/reference/hoon/zuse/2d_7/#ofdejs-softformat)
[`++of:dejs:format`](/reference/hoon/zuse/2d_6/#ofdejsformat)
[`++oj:dejs:format`](/reference/hoon/zuse/2d_6/#ojdejsformat)
[`++om:dejs-soft:format`](/reference/hoon/zuse/2d_7/#omdejs-softformat)
[`++om:dejs:format`](/reference/hoon/zuse/2d_6/#omdejsformat)
[`++op:dejs-soft:format`](/reference/hoon/zuse/2d_7/#opdejs-softformat)
[`++op:dejs:format`](/reference/hoon/zuse/2d_6/#opdejsformat)
[`++ot-raw:dejs-soft:format`](/reference/hoon/zuse/2d_7/#ot-rawdejs-softformat)
[`++ot-raw:dejs:format`](/reference/hoon/zuse/2d_6/#ot-rawdejsformat)
[`++ot:dejs-soft:format`](/reference/hoon/zuse/2d_7/#otdejs-softformat)
[`++ot:dejs:format`](/reference/hoon/zuse/2d_6/#otdejsformat)
[`++ou-raw:dejs:format`](/reference/hoon/zuse/2d_6/#ou-rawdejsformat)
[`++ou:dejs:format`](/reference/hoon/zuse/2d_6/#oudejsformat)
### p
[`++pa:dejs:format`](/reference/hoon/zuse/2d_6/#padejsformat)
[`++pairs:enjs:format`](/reference/hoon/zuse/2d_1-5/#pairsenjsformat)
[`++path:enjs:format`](/reference/hoon/zuse/2d_1-5/#pathenjsformat)
[`++pe:dejs-soft:format`](/reference/hoon/zuse/2d_7/#pedejs-softformat)
[`++pe:dejs:format`](/reference/hoon/zuse/2d_6/#pedejsformat)
### r
[`++re:dejs-soft:format`](/reference/hoon/zuse/2d_7/#redejs-softformat)
### s
[`++sa:dejs-soft:format`](/reference/hoon/zuse/2d_7/#sadejs-softformat)
[`++sa:dejs:format`](/reference/hoon/zuse/2d_6/#sedejsformat)
[`++sd:dejs:format`](/reference/hoon/zuse/2d_6/#sddejsformat)
[`++se:dejs:format`](/reference/hoon/zuse/2d_6/#sedejsformat)
[`++sect:enjs:format`](/reference/hoon/zuse/2d_1-5/#sectenjsformat)
[`++ship:enjs:format`](/reference/hoon/zuse/2d_1-5/#shipenjsformat)
[`++so:dejs-soft:format`](/reference/hoon/zuse/2d_7/#sodejs-softformat)
[`++so:dejs:format`](/reference/hoon/zuse/2d_6/#sodejsformat)
[`++su:dejs-soft:format`](/reference/hoon/zuse/2d_7/#sudejs-softformat)
[`++su:dejs:format`](/reference/hoon/zuse/2d_6/#sudejsformat)
### t
[`++tank:enjs:format`](/reference/hoon/zuse/2d_1-5/#tankenjsformat)
[`++tape:enjs:format`](/reference/hoon/zuse/2d_1-5/#tapeenjsformat)
[`++time:enjs:format`](/reference/hoon/zuse/2d_1-5/#timeenjsformat)
[`++to-wain:format`](/reference/hoon/zuse/2d_1-5/#to-wainformat)
### u
[`++uf:dejs:format`](/reference/hoon/zuse/2d_6/#ufdejsformat)
[`++ul:dejs-soft:format`](/reference/hoon/zuse/2d_7/#uldejs-softformat)
[`++ul:dejs:format`](/reference/hoon/zuse/2d_6/#uldejsformat)
[`++un:dejs:format`](/reference/hoon/zuse/2d_6/#undejsformat)
### w
[`++wall:enjs:format`](/reference/hoon/zuse/2d_1-5/#wallenjsformat)
### z
[`++za:dejs-soft:format`](/reference/hoon/zuse/2d_7/#zadejs-softformat)
[`++za:dejs:format`](/reference/hoon/zuse/2d_6/#zadejsformat)
[`++zl:dejs-soft:format`](/reference/hoon/zuse/2d_7/#zldejs-softformat)
[`++zl:dejs:format`](/reference/hoon/zuse/2d_6/#zldejsformat)
[`++zm:dejs-soft:format`](/reference/hoon/zuse/2d_7/#zmdejs-softformat)
[`++zm:dejs:format`](/reference/hoon/zuse/2d_6/#zmdejsformat)
[`++zp:dejs-soft:format`](/reference/hoon/zuse/2d_7/#zpdejs-softformat)
[`++zp:dejs:format`](/reference/hoon/zuse/2d_6/#zpdejsformat)
## By Section
### 2d (1-5): Formatting functions: Line lists and JSON encoding
[`++to-wain:format`](/reference/hoon/zuse/2d_1-5/#to-wainformat)
[`++of-wain:format`](/reference/hoon/zuse/2d_1-5/#of-wainformat)
[`++of-wall:format`](/reference/hoon/zuse/2d_1-5/#of-wallformat)
[`++json-rn:format`](/reference/hoon/zuse/2d_1-5/#json-rnformat)
[`++enjs:format`](/reference/hoon/zuse/2d_1-5/#enjsformat)
[`++frond:enjs:format`](/reference/hoon/zuse/2d_1-5/#frondenjsformat)
[`++pairs:enjs:format`](/reference/hoon/zuse/2d_1-5/#pairsenjsformat)
[`++tape:enjs:format`](/reference/hoon/zuse/2d_1-5/#tapeenjsformat)
[`++wall:enjs:format`](/reference/hoon/zuse/2d_1-5/#wallenjsformat)
[`++ship:enjs:format`](/reference/hoon/zuse/2d_1-5/#shipenjsformat)
[`++numb:enjs:format`](/reference/hoon/zuse/2d_1-5/#numbenjsformat)
[`++sect:enjs:format`](/reference/hoon/zuse/2d_1-5/#sectenjsformat)
[`++time:enjs:format`](/reference/hoon/zuse/2d_1-5/#timeenjsformat)
[`++path:enjs:format`](/reference/hoon/zuse/2d_1-5/#pathenjsformat)
[`++tank:enjs:format`](/reference/hoon/zuse/2d_1-5/#tankenjsformat)
### 2d (6): Formatting functions: JSON decoding
[`++dejs:format`](/reference/hoon/zuse/2d_6/#dejsformat)
[`++ar:dejs:format`](/reference/hoon/zuse/2d_6/#ardejsformat)
[`++as:dejs:format`](/reference/hoon/zuse/2d_6/#asdejsformat)
[`++at:dejs:format`](/reference/hoon/zuse/2d_6/#atdejsformat)
[`++at-raw:dejs:format`](/reference/hoon/zuse/2d_6/#at-rawdejsformat)
[`++bo:dejs:format`](/reference/hoon/zuse/2d_6/#bodejsformat)
[`++bu:dejs:format`](/reference/hoon/zuse/2d_6/#budejsformat)
[`++ci:dejs:format`](/reference/hoon/zuse/2d_6/#cidejsformat)
[`++cu:dejs:format`](/reference/hoon/zuse/2d_6/#cudejsformat)
[`++di:dejs:format`](/reference/hoon/zuse/2d_6/#didejsformat)
[`++du:dejs:format`](/reference/hoon/zuse/2d_6/#dudejsformat)
[`++mu:dejs:format`](/reference/hoon/zuse/2d_6/#mudejsformat)
[`++ne:dejs:format`](/reference/hoon/zuse/2d_6/#nedejsformat)
[`++ni:dejs:format`](/reference/hoon/zuse/2d_6/#nidejsformat)
[`++no:dejs:format`](/reference/hoon/zuse/2d_6/#nodejsformat)
[`++nu:dejs:format`](/reference/hoon/zuse/2d_6/#nudejsformat)
[`++of:dejs:format`](/reference/hoon/zuse/2d_6/#ofdejsformat)
[`++ot:dejs:format`](/reference/hoon/zuse/2d_6/#otdejsformat)
[`++ot-raw:dejs:format`](/reference/hoon/zuse/2d_6/#ot-rawdejsformat)
[`++ou:dejs:format`](/reference/hoon/zuse/2d_6/#oudejsformat)
[`++ou-raw:dejs:format`](/reference/hoon/zuse/2d_6/#ou-rawdejsformat)
[`++oj:dejs:format`](/reference/hoon/zuse/2d_6/#ojdejsformat)
[`++om:dejs:format`](/reference/hoon/zuse/2d_6/#omdejsformat)
[`++op:dejs:format`](/reference/hoon/zuse/2d_6/#opdejsformat)
[`++pa:dejs:format`](/reference/hoon/zuse/2d_6/#padejsformat)
[`++pe:dejs:format`](/reference/hoon/zuse/2d_6/#pedejsformat)
[`++sa:dejs:format`](/reference/hoon/zuse/2d_6/#sedejsformat)
[`++sd:dejs:format`](/reference/hoon/zuse/2d_6/#sddejsformat)
[`++se:dejs:format`](/reference/hoon/zuse/2d_6/#sedejsformat)
[`++so:dejs:format`](/reference/hoon/zuse/2d_6/#sodejsformat)
[`++su:dejs:format`](/reference/hoon/zuse/2d_6/#sudejsformat)
[`++uf:dejs:format`](/reference/hoon/zuse/2d_6/#ufdejsformat)
[`++un:dejs:format`](/reference/hoon/zuse/2d_6/#undejsformat)
[`++ul:dejs:format`](/reference/hoon/zuse/2d_6/#uldejsformat)
[`++za:dejs:format`](/reference/hoon/zuse/2d_6/#zadejsformat)
[`++zl:dejs:format`](/reference/hoon/zuse/2d_6/#zldejsformat)
[`++zp:dejs:format`](/reference/hoon/zuse/2d_6/#zpdejsformat)
[`++zm:dejs:format`](/reference/hoon/zuse/2d_6/#zmdejsformat)
### 2d (7): Formatting functions: JSON decoding (unit)
[`++dejs-soft:format`](/reference/hoon/zuse/2d_7/#dejs-softformat)
[`++ar:dejs-soft:format`](/reference/hoon/zuse/2d_7/#ardejs-softformat)
[`++at:dejs-soft:format`](/reference/hoon/zuse/2d_7/#atdejs-softformat)
[`++at-raw:dejs-soft:format`](/reference/hoon/zuse/2d_7/#at-rawdejs-softformat)
[`++bo:dejs-soft:format`](/reference/hoon/zuse/2d_7/#bodejs-softformat)
[`++bu:dejs-soft:format`](/reference/hoon/zuse/2d_7/#budejs-softformat)
[`++ci:dejs-soft:format`](/reference/hoon/zuse/2d_7/#cidejs-softformat)
[`++cu:dejs-soft:format`](/reference/hoon/zuse/2d_7/#cudejs-softformat)
[`++da:dejs-soft:format`](/reference/hoon/zuse/2d_7/#dadejs-softformat)
[`++dank:dejs-soft:format`](/reference/hoon/zuse/2d_7/#dankdejs-softformat)
[`++di:dejs-soft:format`](/reference/hoon/zuse/2d_7/#didejs-softformat)
[`++mu:dejs-soft:format`](/reference/hoon/zuse/2d_7/#mudejs-softformat)
[`++ne:dejs-soft:format`](/reference/hoon/zuse/2d_7/#nedejs-softformat)
[`++ni:dejs-soft:format`](/reference/hoon/zuse/2d_7/#nidejs-softformat)
[`++no:dejs-soft:format`](/reference/hoon/zuse/2d_7/#nodejs-softformat)
[`++of:dejs-soft:format`](/reference/hoon/zuse/2d_7/#ofdejs-softformat)
[`++ot:dejs-soft:format`](/reference/hoon/zuse/2d_7/#otdejs-softformat)
[`++ot-raw:dejs-soft:format`](/reference/hoon/zuse/2d_7/#ot-rawdejs-softformat)
[`++om:dejs-soft:format`](/reference/hoon/zuse/2d_7/#omdejs-softformat)
[`++op:dejs-soft:format`](/reference/hoon/zuse/2d_7/#opdejs-softformat)
[`++pe:dejs-soft:format`](/reference/hoon/zuse/2d_7/#pedejs-softformat)
[`++re:dejs-soft:format`](/reference/hoon/zuse/2d_7/#redejs-softformat)
[`++sa:dejs-soft:format`](/reference/hoon/zuse/2d_7/#sadejs-softformat)
[`++so:dejs-soft:format`](/reference/hoon/zuse/2d_7/#sodejs-softformat)
[`++su:dejs-soft:format`](/reference/hoon/zuse/2d_7/#sudejs-softformat)
[`++ul:dejs-soft:format`](/reference/hoon/zuse/2d_7/#uldejs-softformat)
[`++za:dejs-soft:format`](/reference/hoon/zuse/2d_7/#zadejs-softformat)
[`++zl:dejs-soft:format`](/reference/hoon/zuse/2d_7/#zldejs-softformat)
[`++zp:dejs-soft:format`](/reference/hoon/zuse/2d_7/#zpdejs-softformat)
[`++zm:dejs-soft:format`](/reference/hoon/zuse/2d_7/#zmdejs-softformat)
### 2e (2-3): Web text: JSON printing and parsing
[`++en-json:html`](/reference/hoon/zuse/2e_2-3/#en-jsonhtml)
[`++de-json:html`](/reference/hoon/zuse/2e_2-3/#de-jsonhtml)