Concepts
Test doc
does it publish Does it edit
Standoff Properties
How do we encode textual information in the Hypermedia protocol? Text Encoding Techniques This is (roughly) the approach that we use in the Hypermedia protocol. Benefit of Standoff Properties With HTML, this must be encoded as: <p> <em>overlapping <b>annotations</b></em> <b>cause problems</b> </p> Notice how there are two bold tags even though there is only one range of bold text. With Standoff Properties we have a much cleaner result: { "text": "overlapping annotations cause problems" "annotations": [ { "type": "italic", "at": [0, 23] } { "type": "bold", "at": [12, 38] } ] } This becomes even more important as we support a more diverse set of text annotations over time, and support annotations from a variety of authors. Linking In the future we plan to support this, as well as showing backlinks to overlapping ranges of text. References
How Seed Hypermedia Works WIP
Publishing Without Barriers Web of Trust Community Preservarion
How to form References in Seed Hypermedia
Comment
A Comment contains hierarchal Content from a single author that is attached to a single document, known as the Target Document of the comment.
Document
A Document is the base of organizing knowledge. It is comparable to a single PDF or web page. A document describes what may appear within a single window at one time. Content The Document Content contains the full message that the authors are intending to share. It is saved inside the content field. Attributes Navigation Theme Example Snapshot
Presentation
The Client is the app or web software that is responsible for rendering the Hypermedia Structure. The Body is the author-controlled area of a Site and Document. On the web Client, it takes up the whole window (matching the html <body>). In desktop Clients, it takes up the main view (under the app's title bar, right of the navigation sidebar, left of the panels, and above the app footer) Here we define the Presentation: how Sites and Documents should be rendered by the Client inside the Body. Visual summary of the suggested Presentation Site Header Navigation Breadcrumb Mobile Support
Structure in Seed Hypermedia
Brainstorming
storm the brain
Example Document Snapshots
Site with Outline Navigation This Document will have the following Navigation structure. Because the navigation is not explicitly defined in the document, the nav is an Outline of the Document content: Site with Shared Sidebar
Navigation Presentation
The Navigation Presentation is intended to help the user move around the content. The Navigation Presentation will vary depending on the context where the Navigation is shown. For example: Navigation Links Navigation Block Types Critically, many blocks will not be shown in the Navigation Presentation. The following blocks will appear: Embed Views
Blocks and Block Hierarchy
Blocks Text Blocks Block Types Annotation Types
Content Presentation
Content is rendered by vertically stacking all the Blocks. Hierarchy Collapsing
FAQ
Addressing questions that pop up. (Ready for the team to set fire to this proposal!) Sidebar Navigation
Site
A Site is the container for Documents. It may be published independently to the web. Each Document in a Site is addressed using a Path. Documents in a Site may contain Capabilities, which grant permissions to other Accounts to edit a Document (and optionally to Sub-Documents) Hypermedia URLs are created for all Documents in the Site by using the Site ID plus the Document Path. Home Document Sub-Document
Goals
Goals for this Structure Proposal Knowledge Structure Map to Presentation Coherence and clarity of API Consistency Minimalist Non-Goals
Hypermedia Theming and Layouts
An idea for how hypermedia site owners can manage their site and apply visual consistency Distribution Themes Layouts Document Blocks CHANGED
Web Development
How to Develop Seed Sites
Seed Developers