Brainlet - HackMD

--- tags: Garden Contracts --- # Brainlet A "Brainlet" is a standardised HTML5 web component, which is able to display a graph-like representation of semantically linked entities in a flexible manner. - [Brainlet Notes](/lLiYU-sSRYSH21J6R99xow) ## Funders - Jerry Michalski for OGM / FJB - offered $500 - [Mutual Credit Network](/CoZU9FQ8TRmSPaRzGL1dkA) - £5k for [Thingbase](/GUhpDjzRRxeUxpIOuLhRkg) - [Garden Crew](/WFxg8rf_RbeIkFGW5JmFpw) from [Knowledge Casting](/05_H1DIfQV6E2pPBez2S0g) - Other We expect to have a crowdfunding effort on some platform, as well. ## Users Here we list communities and individuals that have expressed an interest in helping design and test the Brainlet: - Dil Green - Jerry Michalski - Lexon Governance Journal - ReGovern.earth # Specification We take a lead from [Joel Spolsky](https://www.joelonsoftware.com/2000/10/03/painless-functional-specifications-part-2-whats-a-spec/) ## Overview A "Brainlet" is a standardised HTML5 web component, which is able to author and display a graph-like representation of semantically linked entities in a flexible manor. This spec is not, by any stretch of the imagination, complete. All of the wording will need to be revised several times before it is finalized. The graphics and layout of the screens is shown here merely to illustrate the underlying functionality. The actual look and feel will be developed over time with the input of graphics designers and iterative user feedback. ## Scenarios We imagine the following scenarios to be possible in each of the following platforms: 1. Federated Wiki as an HTML app embedded in an iFrame. 2. As a TiddlyWiki Plugin similar to [TiddlyMap](/G0X9i7PKRWSVWgi2xPzPzw). 3. As a web component exported for [[Massive Wiki]]. Further we imagine the ability to import elements of TheBrain, or graph data from other sources, as well as the ability to automatically sense context of links in the participating writing environments. The visual and semantic style of the Brainlet, can be specified using some form of "style sheet" in order that the same code can generate a webcompnents semantically and visually suited for a specific knowledge domain. It is not however the aim of the Brainlet to be a general purpose, all encompasing representation. It is sufficent to provide an aesthetically pleasing and visually meaningful navigation device for a subset of use-cases. The only requirement is that the semantic data represented by the Brainlet must be extractable by code so that the visualisation can be updated, merged or replaced by future developments. ### Scenario 1: Mike Mike is a lazy author. He is writing in an online platform for the first time and is unfamiliar with the software. He mainly uses Google Docs. As Mike types his article he is able to simply click on an "Auto Graph" icon overlayed on the Brainlet image that forms part of the header graphic of the article in order to create a unique and aesthetically pleasing graph of articles contents and context. Mike tries this feature out, and is tempted to explore the Bralihlets auto-created links. Some of the links interest him, while others seem irrelevant to the purpose of the article. He finds it easy to delete the links he dislikes, and to make the ones he considers important prominent. He has some ideas about how to improve the image and decides to discuss these with his designer John. ### Scenario 2: John ### Scenario 3: Jerry Jerry likes to draw graphs and mindmaps. He has his own style and workflow and favourite tool. Jerry would like to quickly interact with his favourite tool, and use this graph as a starting point for an essay or publication that he would like to publish on the web or as a pdf. Unfortunately Jerry's tool of choice (TheBrain) does not have an API to directly drive the interaction / export capability that the Brainlet requires. So he uses a hack in the form of a full database dump of his Brain, and an interface that enables him to quickly select a subset of nodes to export. There is the advanced capability to use a key logger, to capture all the nodes navigated and export these to a format that the Brailet can import. Next Jerry manually adds or delete nodes as needed forming a visually pleasing if imperfect Brainlet rendition of the subgraph. Jerry then exports the Brainlets SVG and hands it off to a graphic desinger, who uses Illustrator / incscape / Omnigraffle to finish the visual desing, prior to reimporting into the web page. ### Scenario 4: Dil ### Scenario 5: Moira ## Non-goals The Brainlet does not attempt do fulfill the following needs: 1. General Purpose drawing or graphing 2. Sophisticated control over the generated graph 3. Animations or other dynamic elements 4. The image should be static, no zoom or pahhing or wobble Some of these additional needs are met by: - [Brainlet Authoring](/aF6LFIyKRTm2ATvtTB-HMA) - [Brainlet Editor](/RK2TWeW9QPG3W-ipra0nlA) - [Brainlet SVG](/0th8imDHTl6aZ5bPff3CtQ) ## Flowchart ## Screen by Screen Specification