PawPub

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Pages (not final) ======

The **Pages** extension defines a kind of note that includes a long-form article, allowing users to share and link to stand-alone documents.

Within the page content, links to PawPub objects (including other pages, as well as notes, actors, etc) should **not** use the markup language's own link mechanism, instead they should be defined in the links array. This allows them to use in-app / local instance links instead of opening the remote [[:instance]], and makes it easier for software to discover relationships between pages. Links to other websites should use markup links as normal.


===== Schema =====

  * title: string required
  * content: object required
    * (media-type): string many
  * links: array(object) optional default=[]
    * range: object required
      * (media-type): range((A range is just a string with a zero-indexed start and end position (start-inclusive, end-exclusive) separated by a hyphen. For example, if a link was present starting at the first character and ending at the tenth, the range would be "0-10". Characters should be counted by the number of Unicode code points, similarly to [[https://xmpp.org/extensions/xep-0426.html|XEP-0426]].)) required
    * target: uri(note)


===== Notes =====

  * The content field(s) of the note can be set to an abridged preview of the page's title/content, or just a message along the lines of "published a new page," and should include a link to the page on the original instance, so that software that doesn't support the extension will give the user a way to open the page on the remote instance instead, so they can still see it.
  * When notes with an attached page are shown to users on software which supports pages, the content of the note should **not** be shown, instead being replaced by a localised message and a link to the page on the local instance or a button to open it in-app. Alternatively the note can be hidden entirely, if there is another sufficient way to access pages. In either case, the page itself should never be shown inline (e.g. in timelines or user profile pages).


===== Example =====
<code javascript>
{
"type": "note",
"plainContent": "\"Why you should use Pages\" - https://example.social/page/123",
...
"extensions": {

"https://pawpub.entities.org.uk/extension/pages": {
    "title": "Why you should use Pages",
    "content": {
        "text/markdown": "important reason here!!!! **wow** look at this other page",
        "text/html": "important reason here!!!! <strong>wow</strong> look at this other page",
    },
    "links": [{
        "target": "https://social.example/note/another-page",
        "range": {
            "text/markdown": "42-57",
            "text/html": "55-70"
        }
    }]
}

}
}
</code>