Copy, paste and print

​

What copy writes

• Plain text: the text a reader sees, with no Markdown syntax or escapes.
• HTML: semantic markup, such as headings, lists, <strong>, <mark>, tables, links and footnotes.

​

Copy as Markdown

import { InkKitError } from '@aicayzer/inkkit'

declare function writeClipboardText(text: string): Promise<void>
declare function showMessage(text: string): void

async function copyAsMarkdown(): Promise<void> {
  try {
    const output = await editor.clipboardSnapshot('selection')
    await writeClipboardText(output.markdown)
  } catch (error) {
    if (!(error instanceof InkKitError)) throw error
    showMessage(`Couldn't copy (${error.code}).`)
  }
}

​

Images and diagrams on a native clipboard

import {
  InkKitEditor,
  type ClipboardOutput,
  type DocumentSnapshot,
} from '@aicayzer/inkkit'

declare function scheduleSave(snapshot: DocumentSnapshot): void
declare function writeNativeClipboard(content: ClipboardOutput): Promise<void>

const inkkit = await InkKitEditor.mount(root, {
  changed: (snapshot) => scheduleSave(snapshot),
  clipboard: (content) => writeNativeClipboard(content),
})

• html embeds each image as a data: URL. images lists the portable bytes, which come from your adapter’s export, in the order they appear in html. A diagram’s image has an empty reference.
• diagrams holds each complete diagram’s source and a PNG. A diagram that can’t be exported has an error and stays readable code in html.
• An image or diagram whose bytes aren’t available has an error and appears as text, such as [Photo: image unavailable]. Degraded output describes itself and isn’t also reported as an error.
• A cut removes the selection only after the handler resolves. If the handler throws or rejects, or a selected image or diagram can’t be copied, the cut removes nothing and events.error receives the reason.

​

How paste is imported

1. Into a code block: the text is inserted as is.
2. Explicit Markdown: markdown, which only paste can supply, is read as Markdown. HTML that comes with it is used only to find its images.
3. A spreadsheet: HTML that is one table, or text that contains a tab, becomes a table. See Spreadsheets.
4. HTML: a web page, notes app or word processor imports as readable content. See Web pages.
5. Images without HTML: each image goes through your image adapter and becomes its own paragraph.
6. Plain text: read as Markdown. A web address pasted over selected text links that text instead.

import { InkKitError, type ClipboardInput } from '@aicayzer/inkkit'

declare function showMessage(text: string): void

async function pasteFromHost(
  input: ClipboardInput,
  generation: number,
): Promise<void> {
  try {
    await editor.paste(input, generation)
  } catch (error) {
    if (error instanceof InkKitError && error.code === 'preservation') {
      showMessage("This content can't be pasted here. Try Paste as Plain Text.")
      return
    }
    throw error
  }
}

​

Web pages

• Left out: HTML comments, style, meta, title, input, the contents of template and noscript, and elements hidden with the hidden attribute or an inline display: none.
• Simplified: u, sub, small, abbr, cite and similar wrappers keep their text without the wrapper. figure keeps its image and caption text. A definition list becomes a bold term and a plain paragraph for each entry. A checkbox at the start of a list item makes a task item.
• Whitespace collapses as in a browser, except in pre, code and elements whose inline style preserves whitespace, so copied code keeps its indentation. Style sheets aren’t read.
• Literal source: custom elements, script, iframe, svg, math, object, form controls such as button and textarea, and other unrecognized elements stay literal source when it reads back as written, and otherwise import as a code block with the same text. HTML is never executed.
• Images are never saved by address: your adapter stores the bytes and returns the reference.

​

Spreadsheets

• Rows can end in LF, CRLF or CR, and fields can use paired double quotes with doubled quotes inside. Short rows are padded with empty cells.
• Outside a table, the first row becomes the header of a new table. HTML column alignment carries over.
• Inside a table, the paste fills and grows a rectangle from the selected cell. Header cells stay headers.
• Tables are limited to 100 rows and 100 columns, including growth.
• Cell text is literal: Markdown punctuation in it is escaped on save.

​

Links that Inkkit keeps

• shows without an address in the editor, so Mod-click doesn’t open it;
• is refused by format('link') with invalid-argument;
• is copied, imported from HTML and printed as its text.

​

Print

• It doesn’t depend on the selection, scrolling, folding or comment visibility, and it doesn’t change the source, revision or history.
• It includes footnotes, resolved reference links, tables, images, highlights, Mermaid diagrams as images, and the full body of folded callouts. It leaves out author comments and editor controls, even when comments are shown. TXT prints as literal text.
• Images are embedded as data: URLs from your adapter, and assets holds copies of their bytes. styles holds the print CSS on its own, which wraps long text and fits images to the page; adapt it to your paper and layout.