Known limits
What Inkline does not do, or does not do everywhere, and what to do instead. The issues track each one.
In general
- Desktop only. Obsidian's mobile apps do not offer Inkline. The host tests run on Linux; Windows and macOS should work but are not tested.
- Mouse or trackpad. A drawing tablet's pen or a touchscreen draws as a mouse does: pen pressure and a pen's eraser end are not supported.
- With Flat ends and the grid both on, the eraser's edge can shift along a curve. An eraser stroke drawn freehand that starts while both are on is drawn as in 1.0.1, so that Flat ends can stop its ends flush with a row. Behind a large brush moving along a curve, most of all slowly, the edge it leaves in the ink then shifts while you erase, and a little ink can come back beside the way it went, a few pixels outside the brush's circle. Some of it stays when you let go (#341). Turn Flat ends off to erase along a curve: the eraser then takes away exactly what its circle passes over, and its ends stay round, whatever you turn on during the stroke. With both on, a smaller brush shifts the edge less, and Shift draws a straight stroke, which barely shifts.
- Zoom during a stroke can move its end. Pressing Zoom (Z) while drawing a stroke, with the pen or the eraser, changes where the pointer falls in the drawing, so letting go without moving the pointer again ends the stroke somewhere other than its preview showed (#382). Change Zoom between strokes; Undo takes back a stroke that went wrong.
- Large libraries show 100 symbols at a time, with Show more for the next 100. Filter them, or choose a folder, to narrow the list.
- Library insertion needs a sidebar. If the library's tab is dragged into the main area, move it back to a sidebar to insert into a note.
- A double-click opens a symbol only where its second click reaches it. In Reading view, embedded notes, hover previews, and a focused canvas card, the first click opens Obsidian's image viewer, and in a callout in Live Preview it shows the callout as text (#264). Right-click the symbol there for Edit symbol.
- A line whose first letter is in a symbol's name runs in that name's direction in Live Preview.
8 ![[مرحبا.ink.png]]runs right to left there, and left to right in Reading view. Live Preview takes a line's direction from the first letter of the text as you wrote it, which here is inside the embed, and Reading view from the text it shows, where a symbol shows no letters (#301). A word of your own before the symbol gives the line its direction in both. - Physical printing has not been checked. Native PDF export is verified on Linux.
- A faint line along a symbol's edge in a PDF. In text colour, some PDF viewers draw one at some zoom levels, as Export a note to PDF says (#255). Symbols in stored colour show none.
- A size you write into an embed, wider than its space, as
![[wide.ink.png|1000]]in a hover preview, keeps the symbol's shape and its baseline, but its line keeps the room below the baseline that the size asked for:|1000of a symbol 400 × 192 in a 700-pixel line leaves 36 pixels of line below it. Remove the size, or make it narrower, to close it up. - Up to a pixel or two off the baseline. The letters of a line and the box a symbol is drawn in each start on whole pixels of the screen, so at some text sizes, Symbol sizes, and zoom levels a symbol stands above or below the letters beside it: up to about a pixel at 100% zoom, and up to about two at other zoom levels: as measured, up to 1.75 pixels in Obsidian 1.13.4 and 1.00 in 1.15.1 (#261). The symbols of a line are within half a pixel of each other at 100% zoom, and within a pixel at other zoom levels, and in Obsidian's default 16-pixel text at 100% zoom a symbol stands exactly on the letters' baseline.
Links Obsidian writes
With Use [[Wikilinks]] off, Obsidian writes Markdown links, and leaves a % or an unbalanced parenthesis in a file name as it is, so that such a link can lead nowhere or to another file (#35). Inkline checks every embed it inserts: it writes such a % as %25, and names a symbol whose link would still lead elsewhere by its path in the vault.
A file written at the moment Inkline saves
Inkline's own saves of symbols go one at a time, whether from the editor or the library, and each reads the file first, so that two of them cannot undo each other, even if the file is renamed or replaced while one waits. It also means that a save Obsidian never finishes, as on a drive that stops answering, holds up every later save, whichever symbol it is for. After a few seconds of that, the editor and the library's fields say so, and saving goes on by itself if Obsidian finishes. A save is never let go of early, as Obsidian could still finish it, over whatever a later save had written. If nothing changes, restart Obsidian, which ends the wait:
- In the editor, your strokes are safe in a draft. Open the symbol again, or start a new symbol in that note if it had not been saved yet, and choose Restore.
- In the library's fields, what you typed stays there, and you can select and copy it. Copy it before you restart, as a restart does not keep it. Cancel or Esc closes the fields and stops the save. Only a save that had already reached Obsidian can still finish, and a notice says so.
A rename is not in that line, so a save never waits for one, and it is told apart differently, as it can rightly take a long time: Obsidian's question about links stays open for as long as you like, and it then updates each note that links to the symbol, which takes a few seconds for every thousand notes. So only a rename where nothing happens for a few seconds, with no question open, says it is waiting for Obsidian, and the message goes if it moves again. If nothing changes, restart Obsidian:
- In the library, the name you typed stays in the row to copy, as a restart does not keep it. Cancel or Esc closes the row, and stops the rename if Obsidian has not begun it yet. One it has begun can still finish, and a notice says so, and says again when it ends, whether it worked or not. Until then another rename of that symbol is refused, and says why.
- In the library's Quick edit, a save that changes the name and the readings or translations writes them first. Leaving it while that write waits leaves the name as it was, even if the write still finishes. Leaving it while the rename waits keeps them saved, as the row and a notice say.
- In the editor, the drawing is saved by then, and the name is in the draft.
- Obsidian moves the file before it updates the links. A restart while it updates them leaves the notes it had not reached with the old name, whose embeds no longer find the symbol.
Inkline cannot do the same with another program. Obsidian writes a binary file only as a whole, with no way to write it only if it has not changed since it was read, so a sync tool that writes the file in the moment between Inkline's last read and its write can have that change replaced. Inkline keeps that moment short, with the read straight before the write, and it does not rule it out. A change made before that read is noticed: the editor asks, and the library shows it. Your sync tool's own history is the way back from a change lost like this.
A file deleted and another put at its path in that moment is the same, as Obsidian writes to a path, so the write lands on the new file. Obsidian reads and writes the vault's files one after another, and Inkline waits for anything another plugin or a sync tool asks of Obsidian during its last read, then looks again. That leaves a program writing to the disk outside Obsidian in the moment Obsidian writes, and a disk so busy that something is asked during each of three looks, after which Inkline writes as it did before it waited, as it does with a version of Obsidian that keeps its line where Inkline cannot see it. A save that finds its file gone once it has written says so, and keeps what you drew or typed. The first save of a new symbol is not looked at this way: Obsidian checks that nothing is at its path just before it writes, and only something asked in that moment comes between.
A file changed as Obsidian renames it
Obsidian moves a file by its path, without checking that the file there is still the one it was asked to rename, and its rename can first wait a while, for its index of the vault and for any other rename. So Inkline waits for those itself before it checks the symbol for the last time, and Obsidian begins to move the file in the same step as that check. Inkline learns what Obsidian is waiting for from Obsidian's own state, which its plugin API does not include (#10). With a version of Obsidian that keeps it otherwise, Obsidian waits after the check, as it did before, and it can then say a rename is done before it has made it, which Inkline reports as a name that may still change.
Some changes can still reach the file between the check and the move: one that Obsidian had already begun to write to the disk, and one made outside Obsidian at that moment, as by a sync tool. If anything is deleted, created, or renamed at the symbol's path or its new one before Obsidian has moved it, Inkline says what happened and where the symbol is now, rather than closing the library's row or saying only that the editor saved. Obsidian may by then have given the new name to another file at the old path, or moved the symbol away from a name given elsewhere, and Inkline cannot stop a move Obsidian has begun: look at both names in the library before going on.
Renames and Obsidian's question
When a file is renamed, Obsidian notes where the links to it are, asks whether to update them, and after your answer writes at those places without checking what is there now. If a note changed in between, the new link goes over other text, which is lost. A note's own save, two seconds after an edit, is enough. Obsidian does this with any file (#10).
Inkline's own renames save every open note first, which leaves that save nothing to do, and refuse to go on if one cannot be saved (#182). A note typed in while the others are being saved is saved again before the rename starts. What stays out of Inkline's reach:
- Text that arrives during the question, from another window or a plugin, if the note saves itself before you answer. Answer the question first.
- Renames outside Inkline, as in Obsidian's file explorer, which save nothing first. Use the library or the symbol's editor to rename a symbol while its notes are open, or close them.
- Notes edited inside a Canvas card, which Inkline cannot reach to save.
- A disk that stalls for seconds. Obsidian's own save can then meet its reload of the same note and take unsaved text out of the editor, with no symbol involved. After a rename by Inkline the text usually comes back once the file has been read again, and if the note has still not settled after five seconds, a notice asks you to check the embed. If a read held up by the stall lands last, the text leaves the editor for good, with no notice. The file still holds it then, until the next save, so if lines vanish after a stall, undo or reopen the note before typing.
A note that starts with a byte order mark, which Obsidian does not support, has any rename's links written one character early, which loses the character before each one (#185). Remove the mark before renaming what it links to.
Files and sizes
- A symbol is at most 4096 pixels wide, 32 times the height of its text.
- A symbol saved without a name takes the lowest number free in its folder, as
001, filling gaps, and every device picks it the same way. Two devices that each make one before they sync give their symbols the same name, and a sync tool then keeps one file of the two: Obsidian Sync keeps the one changed last, so the other drawing is replaced without a word. On one device, a new symbol can take the number of one you deleted, and a note that still embeds the deleted one then shows the new one (#299). Name symbols as you make them, or let sync finish before you make new ones on a second device. - A symbol saved before 0.9.2 keeps its look but not its strokes. The file format became final in that release, and no later version reads the strokes of earlier files. The symbol stays in your notes and opens as a picture to draw over.
- Tools that change or recompress a symbol's image can drop the strokes it keeps, leaving a picture; see Without Inkline.
- A symbol holds at most 250,000 points across its strokes, erased ones included. That is minutes of unbroken drawing with the fastest mice. Saving past it fails with a message, and the draft stops at the last stroke within it, so undo what took the drawing over. An eraser stroke drawn freehand without Flat ends and the grid both on keeps the outline of the area it took away. In the strokes measured, that was about three times the points of a pen stroke as long, and up to nearly seven times for a slow curve with XL. With XL, a tap holds a few dozen points, where the pen's holds one. One drawn with both on holds as many as a pen stroke, as before.
- Saving a symbol with a large base layer from the editor takes two or three seconds near the limit, and Obsidian keeps answering all through it. A symbol drawn by hand takes milliseconds. What remains is a pause of up to about a quarter of a second just after you ask to save, while Inkline keeps a copy of the base layer for a draft, in one write that it cannot divide (#200).
- Opening such a symbol in the editor takes a second or two near the limit. Obsidian keeps answering while Inkline reads it, and a notice says that it is opening. The longest pauses left are about a tenth of a second, up to a quarter at worst, in single steps that Inkline cannot divide, such as hashing the file (#202).
- A draft keeps only the base layer its drawing uses now. Undo or Redo past a Copy from, a Make ink, or a picture you chose stores that step's base layer again, which takes a moment for a large one. If Obsidian's storage is nearly full, it can then refuse the draft, and a notice says so: save to keep the changes.
- If you turn Inkline off while Obsidian is still renaming a symbol you have just saved, as while it asks about links, the editor keeps a draft, which follows the rename once Obsidian finishes it. Opening the symbol then offers it only if it holds something the file does not, as when you drew after saving or something else changed the file meanwhile. If the vault's local storage refuses it then, it keeps the old name, and a notice says so. If Obsidian is closed before it finishes, as with its question still open, the draft stays as it was kept, so answer the question first.
- A symbol file made to be slow to draw, by a stroke that turns back at nearly every point, can keep Obsidian busy for a long time when you open it in the editor, hours for the worst of them, from a file of a few kilobytes. Close Obsidian if it stops answering: no file has changed, and the note shows the symbol as before. Drawing by hand does not come near this.
- The lists find a symbol by its readings and translations a moment after Obsidian starts, and a few seconds after in a vault of thousands of symbols, as they are read in the background each time; a line in the list says so meanwhile. Names work from the start. A file of over 32 MiB, or with more than 16 chunks of one keyword before a usable one, as a file made to be slow to read has, is found by its name only. Its text still shows in the library's fields.
- A list of readings or translations that Inkline cannot read, as from a later version, stays in the file, behind any you type, and looks empty. Inkline offers no way to remove one.
- A symbol's readings and translations go with its file, and only there. Some image programs drop them; a long list in a non-Latin script was lost through two plain ImageMagick copies, while short text came through.
- A picture to trace over is scaled down to 4096 pixels on its longer side. A file opened from its pixels can be up to 4096 pixels a side, and its ink must fit within 8 MiB, the largest base layer a symbol can store.
- Make ink of a picture with transparency, shown larger than its own pixels, keeps the soft edges of that transparency: they spread across each enlarged pixel, while an opaque picture's edges stay sharp (#96).
- Make ink cannot bring back what a picture has lost. A thin stroke with soft edges, as in a small screenshot, comes out wider than it was drawn: about a third wider for a stroke 2 pixels wide with a pixel of softness. Move the threshold towards the stroke's own tone to thin it. A stroke thinner than its softness also follows the picture's pixels, so that a straight line wavers slightly when enlarged many times. Draw over it, or trace it by hand, where that shows.
- Make ink chooses the threshold's first position from the picture alone, which cannot say what you want traced. A small bright element can draw it away from dim strokes, leaving them no ink: move the slider down to the strokes, or move the picture to keep the element out (#147).
- Make ink counts a capture of a window with transparent corners or a shadow as a transparent picture, so it can start with the ink inverted: the window's ground as the ink, and its strokes as holes. Press Light ink to swap them, then set the threshold with the slider, which cannot swap them by itself. Its edges can stay softer than an opaque picture's. With dark ink, a shadow stays as faint ink around the window at any threshold that keeps the strokes: bring only the inside of the window into view. A capture without transparency has neither limit (#148).
- Images from outside the vault are left as they are, even when their names end in
.ink.png.