Skip to content

GO-7383 Document the cross-space object link in the block text syntax #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
requilence merged 1 commit into from
Sep 19, 2026
Merged

GO-7383 Document the cross-space object link in the block text syntax #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion format/v2/INLINE_MARKUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Where canonical output rewrites the string, the row says so.
| `~x~` | literal | only runs of exactly two tildes delimit |
| `^x^` | literal | |
| `&lt;u&gt;` | the text `<u>` | entities are decoded on input; canonical output writes `\<u>` instead |
| `[t](anytype://object?objectId=X&spaceId=Y)` | an **ordinary link**, param verbatim | a second parameter makes it not-an-object-link. Guessing which half is the id and guessing wrong is unrecoverable, so nothing guesses |
| `[t](anytype://object?objectId=X&spaceId=Y)` | a **cross-space object link** — an ordinary link, param verbatim | the platform's own two-parameter deep link to an object in another space (`core/block/export/writer.go`); a second parameter makes it not-an-object-link here, and guessing which half is the id and guessing wrong is unrecoverable, so nothing guesses. The API expands a short space id in it to the full one on write |

The delimiter set — `**`, `*`, `~~`, `` ` ``, `[…](…)` — is **closed**. A future
version adds a mark as a tag, never as new punctuation, which is what makes
Expand Down
10 changes: 5 additions & 5 deletions format/v2/schema/object.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,7 +941,7 @@
},
"text": {
"type": "string",
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `[text](anytype://object?objectId=<id>&spaceId=<space_id>)` links to an object in another space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
}
}
}
Expand Down Expand Up @@ -970,7 +970,7 @@
},
"text": {
"type": "string",
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `[text](anytype://object?objectId=<id>&spaceId=<space_id>)` links to an object in another space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
}
}
}
Expand All @@ -996,7 +996,7 @@
},
"text": {
"type": "string",
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `[text](anytype://object?objectId=<id>&spaceId=<space_id>)` links to an object in another space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
}
}
}
Expand All @@ -1019,7 +1019,7 @@
},
"text": {
"type": "string",
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `[text](anytype://object?objectId=<id>&spaceId=<space_id>)` links to an object in another space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
}
}
}
Expand All @@ -1045,7 +1045,7 @@
},
"text": {
"type": "string",
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
"description": "The block's text, with formatting written inline. There is no marks array and no offsets. The accepted syntax, and nothing else:\n `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``\n `[text](https://example.com)` links out\n `[text](anytype://object?objectId=<id>)` links to an object in this space\n `[text](anytype://object?objectId=<id>&spaceId=<space_id>)` links to an object in another space\n `<mention object_id=\"<id>\">text</mention>` is a decorated object reference\n `<u>underline</u>`, `<font color=\"red\">text</font>`, `<font background=\"yellow\">text</font>`\nEverything else is literal text: no block syntax, no images, no autolinks, no other HTML. `\\n` is a soft line break. Escape a literal `*`, `` ` ``, `[`, `]`, `~`, `<` or `\\` with a backslash."
}
}
}
Expand Down
Loading