Windows compat: images

[fleimgruber]

Given this typst file exported using ox-typst:

#let _ = ```typ
exec typst c "$0" --root "$(readlink -f "$0" | xargs dirname)/./" --input "file-0=/diagram.svg"
⁠```
#set document(title: "Documentation")
#set text(lang: "en")
#outline()
#set heading(numbering: "1.")
Can we include a diagram?!

#figure([#image(sys.inputs.file-0)]) #label("org2e24fd7")

On compilation I get this error:

typst compile documentation.typ ./documentation.pdf 
error: dictionary does not contain key "file-0"
   ┌─ \\?\C:\Users\LeimgruberF\lg\documentation.typ:10:27
   │
10 │ #figure([#image(sys.inputs.file-0)]) #label("orgce6fa23")
   │                            ^^^^^^

This is on Windows so I assume I am seeing the workaround not working, as mentioned in #20 (comment).

But it seems the issue is with the input key and not with the value?

[jmpunkt]

That is strange. The workaround should work for Windows if both files are located on the same drive (not 100% sure). But based on your generated Typst file, the file should be located next to the Org file?! So this usecase should definitively work.

The error dictionary does not contain key "file-0" suggests that the argument for the file path input is missing (in the compile command). Therefore, you should take a look at the output of org-typst--generate-command. You could modify org-typst-compile by printing the process variable or use a debugger.

[fleimgruber]

Thanks for pointing me in the right direction. I was not thorough in my description and the reproduction steps.

I can confirm that org-typst-compile works alright. What I did was to export to a .typ file and compiled that using typst-ts-compile (from typst-ts-mode). I often export to a file to share with others or do some final modifications.

Are you interested in supporting this use-case as there might be other typst-ts-mode users?

[fleimgruber]

Another question for the "Export As PDF file" case: Could we have a #+ATTR_TYPST: :width 600 similar to https://orgmode.org/org.html#Images-in-LaTeX-export-1? If so should I open a new issue for that?

[jmpunkt]

Are you interested in supporting this use-case as there might be other typst-ts-mode users?

When you are using Linux you could just run sh <path-to-typst> to compile the file. The first line is a hack for Shebang support in Typst (official support was added in 0.13). But I am not sure if that will work on Windows. The whole external files things is annoying with Typst. In the future, it would be nice if we emit the a real shebang (for now I want to support 0.12 as well) and typst-ts-mode would understand that and would use the command specified there.

I wonder if we should provide a mode where we link the files into the workspace, rather than expanding the workspace. This would also work on Windows. I did not look into this because I think it is annoying that a program creates symlinks (as the default behavior). In this case, it would only create symlinks if files are in the parent directory (relative to the Org file).

If so should I open a new issue for that?

I guess a new issue is a good idea. You should describe there what you require. I thought about a similar feature recently as well, we need a way to control elements.

[fleimgruber]

Thanks for explaining!

But I am not sure if that will work on Windows

I do have a MSYS2/MinGW around so I just tried it with sh $FILE.typ and it errors with

Sir? sh .\documentation.typ
error: file not found (searched at \\?\C:\Users\LeimgruberF\lg\Users\LeimgruberF\opt\msys64\diagram.svg)
   ┌─ \\?\C:\Users\LeimgruberF\lg\documentation.typ:10:16
   │
10 │ #figure([#image(sys.inputs.file-0)]) #label("orgae77b23")
   │                 ^^^^^^^^^^^^^^^^^

seems like some path mangling, the svg is at C:\Users\LeimgruberF\lg\diagram.svg next to $FILE.typ. So no workaround today until we have real shebang.

I did not look into this because I think it is annoying that a program creates symlinks (as the default behavior)

I agree and would only use it as a workaround, not as default and expected behavior.

I guess a new issue is a good idea.

Will do.