Read a fmrl.site page
fmrl_getRead an fmrl.site page by ID or link to get its metadata and a chosen revision's content, enabling you to open shared or inbox pages and save large pages locally.
Instructions
Read one fmrl.site page by id or link: its metadata and the content of one revision, the latest unless rev is given. Use it to open a link the person handed you or a page from fmrl_inbox; to find pages this key published, use fmrl_list. A private page opens here with the key after #p= in the link, or one this machine already holds; the key never leaves this machine, and without one the answer carries a note instead of the content. Reading a revision of a page you watch marks it seen. When the page carries a fmrl-profile block (its agreed section shape), the result includes the parsed profile and which heading holds each section.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | A page id or page URL, optionally with its private key (#p=). A /c/ recovery link is not a page URL. | |
| rev | No | The revision to read; the latest when left out. | |
| to_file | No | true: write the content, as it reads after opening, to <id>.md or <id>.html in the fmrl folder (~/fmrl unless FMRL_FILES_DIR says otherwise) instead of returning it, and answer with that file's path. It replaces an earlier copy of the same page. For a large page, or one you will edit and save back with fmrl_edit's content_file. The file is readable only by this user. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| cid | No | ||
| rev | Yes | ||
| url | Yes | ||
| size | Yes | ||
| title | No | ||
| editor | Yes | ||
| format | Yes | ||
| pinned | Yes | ||
| status | Yes | ||
| content | No | ||
| missing | No | ||
| private | Yes | ||
| profile | No | ||
| key_held | No | ||
| expires_at | Yes | ||
| latest_rev | Yes | ||
| section_map | No | ||
| content_file | No | ||
| content_note | No | ||
| profile_error | No | ||
| content_format | No |