@liquidcars/atlas 0.1.48 → 0.1.49

package/README.md

@@ -421,3 +421,53 @@ selección se conserva durante las mutaciones del modelo siempre que el elemento
 siga existiendo. Se mantienen las correcciones de geometría, toolbar, etiquetas,
 paleta externa, edición en caliente y los modos `directed`, `bidirectional` y
 `broken` introducidos en las versiones anteriores.
+
+## Hyperlinked Atlas documents
+
+Entities and relations can keep their external `url` and also declare an
+`atlasRef` such as `atlas:actors/dealer.atlas.md#inventory`. A leading slash
+(`atlas:/overview.atlas.md`) starts at the root of the host's document
+collection; otherwise the path resolves beside the current document. The
+optional fragment selects an entity in the destination. Paths cannot escape
+the collection root.
+
+The information panel accepts `content: { format: "markdown", value: "…" }`
+or `content: { format: "html", value: "…" }`. It also accepts a `source`
+instead of an inline `value` when a content resolver is configured. HTML is
+restricted to text formatting and safe `atlas:` or HTTP(S) links. Existing
+`text` remains the fallback when `content` is absent.
+
+The host supplies documents and optional external content:
+
+```js
+atlas.setDocumentResolver(async ({ uri, from }) => ({
+  uri,
+  model: await loadAndCompileDocument(uri, from)
+}));
+atlas.setContentResolver(async ({ source, from, format }) =>
+  loadContent(source, from, format));
+await atlas.load(initialModel);
+atlas.setDocumentUri("atlas:/overview.atlas.md");
+```
+
+The component exposes `openAtlas(reference)`, `goHome()`, `goBack()`,
+`goForward()`, `goToVisit(index)` and `getDocumentHistory()`.
+Navigation and failures emit `lc-navigation` and `lc-navigation-error`.
+Home, Back and Forward appear in a top navigation bar; holding Back or Forward
+opens a visit list. Hosts with their own top bar can set
+`navigation-controls="external"` and connect those controls to the public
+history methods, as Atlas Studio does. Selecting a linked entity or relation shows a floating link button
+beside it. The information panel remains focused on descriptive content and
+external documentation. Studio's Markdown and visual views can open a local
+folder; they treat that folder as the root of `atlas:/`.
+Where supported, Studio requests read and write directory access. It discovers
+document names, reads files only as they are opened or referenced, and caches
+their text in the current tab. Save writes the active Markdown document back
+to its original file, including edits from the visual editor; switching editors
+preserves the document and visit history. Nothing is sent to a server. Browsers
+without the directory picker use a file-input fallback, whose native dialog may
+call the selection “Upload”; Studio still reads the files locally on demand.
+In that fallback, Save opens a picker or downloads a copy because the selected
+files cannot be written in place.
+See `examples/hyperlinks` for two linked documents and an external Markdown
+information file.