Add exporting to latex template #80

universvm · 2023-06-05T12:30:18Z

Closes #66 .

src/export_command_templates.ts

mokeyish · 2023-06-05T13:38:39Z

Thanks for the contribution👍

src/ui/ExportDialog.tsx

universvm · 2023-06-05T19:40:56Z

Hi @mokeyish this is still a draft. Need to do a bit more work

universvm · 2023-06-06T15:46:23Z

Hi @mokeyish ,

I am currently waiting on pandoc to see how to use relative paths as it seems that resource-path is not being used for .sty files: jgm/pandoc#8894

Have tried a lot but don't seem to be able to export. Essentially if you use iCloud, your files are placed in a folder with a space in its name. Latex does not like spaces. Even when trying to sanitise the path, both in latex and javascript, I still had issues.

The current workaround is to pass the path to the template in the metadata and make sure there are no spaces:

---
title: Your Title
subtitle: ""
authors:
  - name: Leonardo V. Castoirna
    affiliation: School of Informatics
    institution: University of Edinburgh
    email: justanemail@domain.ext
    address: Edinburgh
  - name: Coauthor
    affiliation: Affiliation
    institution: Institution
    email: coauthor@example.com
    address: Address
  - name: Another Author
    affiliation: Another Affiliation
    institution: Another Institution
    email: another.author@example.com
****stylefile: /Users/leo/Desktop/style/neurips***
---

So far I've built two templates. Here are some sample documents

paper.pdf
dissertation.pdf

Generated from this
paper.md

Regarding your points. I updated the UI to this:

Initially I thought it would be best to have the export templates in export_command_templates as you mentioned. But I realised after showing it to people that it was not intuitive. People seem to see "Type" as the file format and it is not intuitive to scroll through all the extensions to then find the correct pdf.

So I ended up creating a conditional element in the UI. If the format can take the template, then you see the above image. Else:

Let me know your thoughts. Also I don't think I will be able to work on this much more. Once I find a fix for the template problem I will push it though not sure when.

mokeyish · 2023-06-07T00:13:15Z

Try to add the path of .sty to --resource-path, it maybe work.
You may have misunderstood what I meant. I mean just put the latex template definition into that file.
latex template selector should be condintional emelent, which is why I asked you whether all types support latex templates at the beginning.

universvm · 2023-06-07T08:09:34Z

The problem is the space in the file path /Users/leo/Library/Mobile Documents/ I believe. I did try with resource-path. It works if the path has no space but iCloud keeps everything in the "Mobile Documents" folder...
and 3. Sorry, I am not sure what you mean. Do you want to define the template path for every export setting?

universvm · 2023-06-07T08:52:06Z

@mokeyish I found a workaround using TEXINPUTS. TEXINPUTS is a variable for setting additional style paths (which is what we need to do here.

On terminal I modified my .zshrc with this:

export TEXINPUTS=/Users/leo/Library/Mobile\ Documents/iCloud~md~obsidian/Documents/exports/.obsidian/plugins/obsidian-enhancing-export/textemplate//:./:$TEXINPUTS

Ideally we just need to use this variable rather than the path ${textemplateDir}

Is this something we can help with? I really need some help here because I don't know JavaScript / Apps set this environment variables...

mokeyish · 2023-06-07T09:00:36Z

@mokeyish I found a workaround using TEXINPUTS. TEXINPUTS is a variable for setting additional style paths (which is what we need to do here.

On terminal I modified my .zshrc with this:
export TEXINPUTS=/Users/leo/Library/Mobile\ Documents/iCloud~md~obsidian/Documents/exports/.obsidian/plugins/obsidian-enhancing-export/textemplate//:./:$TEXINPUTS
Ideally we just need to use this variable rather than the path ${textemplateDir}

Is this something we can help with? I really need some help here because I don't know JavaScript / Apps set this environment variables...

You can set environment variables with following code. (Maybe should make it configurable in the Settings Tab)

await exec('commands', { env: 'TEXINPUTS': 'path/to/textemplate'})

obsidian-enhancing-export/src/utils.ts

Line 24 in 8345d24

export function exec(cmd: string, options?: ExecOptions): Promise<string> {

mokeyish · 2023-06-07T09:06:25Z

The problem is the space in the file path /Users/leo/Library/Mobile Documents/ I believe. I did try with resource-path. It works if the path has no space but iCloud keeps everything in the "Mobile Documents" folder...

and 3. Sorry, I am not sure what you mean. Do you want to define the template path for every export setting?

It seems that my English is really poor, I can't explain my meaning correctly😂.

universvm · 2023-06-07T09:48:28Z

@mokeyish I found a workaround using TEXINPUTS. TEXINPUTS is a variable for setting additional style paths (which is what we need to do here.
On terminal I modified my .zshrc with this:
export TEXINPUTS=/Users/leo/Library/Mobile\ Documents/iCloud~md~obsidian/Documents/exports/.obsidian/plugins/obsidian-enhancing-export/textemplate//:./:$TEXINPUTS
Ideally we just need to use this variable rather than the path ${textemplateDir}
Is this something we can help with? I really need some help here because I don't know JavaScript / Apps set this environment variables...
You can set environment variables with following code. (Maybe should make it configurable in the Settings Tab)
await exec('commands', { env: 'TEXINPUTS': 'path/to/textemplate'})
obsidian-enhancing-export/src/utils.ts

Line 24 in 8345d24

export function exec(cmd: string, options?: ExecOptions): Promise<string> {

Is there a way to access ${textemplateDir} in from that file? Also how do we add += rather than set =to that variable?

TEXINPUTS can contain many paths.

mokeyish · 2023-06-07T10:18:50Z

You should pass your ${textemplateDir} here just as the working directory(cwd).

obsidian-enhancing-export/src/exporto0o.ts

Line 171 in 8345d24

await exec(cmd, { cwd: variables.currentDir });

The concatination of multiple textemplateDirs are different on different platform(unix: join paths with :, windows: join paths with;).

universvm · 2023-06-07T11:23:52Z

Sorry I'm not sure I follow. This is the command we want:

export TEXINPUTS="${textemplateDir}":./:$TEXINPUTS

If you don't mind, could commit the change and I can test it? I'm going crazy working with typescript and doing the template took a really long time...

mokeyish · 2023-06-07T12:32:51Z

Sorry I'm not sure I follow. This is the command we want:
export TEXINPUTS="${textemplateDir}":./:$TEXINPUTS
If you don't mind, could commit the change and I can test it? I'm going crazy working with typescript and doing the template took a really long time...

Just like this:

TEXINPUTS = joinEnvPath(textemplateDir, orignal_TEXINPUTS)

obsidian-enhancing-export/src/utils.ts

Lines 53 to 60 in f0ce1d0

    
           export function joinEnvPath(...paths: string[]) { 
        
             switch (platform) { 
        
               case 'win32': 
        
                 return paths.join(';'); 
        
               default: 
        
                 return paths.join(':'); 
        
             } 
        
           }

mokeyish · 2023-06-07T13:32:15Z

Saw your email, don't worry. Please rewrite following code:

obsidian-enhancing-export/src/exporto0o.ts

Line 171 in f0ce1d0

await exec(cmd, { cwd: variables.currentDir });

as:

// orginal `$TEXINPUTS` should be empty, so ignore it.
await exec(cmd, { cwd: variables.currentDir, env: { TEXINPUTS: joinEnvPath('path/to/texttemplates/', './') } });

universvm · 2023-06-07T21:05:35Z

Hey @mokeyish I think we are close! I changed the variable to this:

 await exec(cmd, { cwd: variables.currentDir, env: { TEXINPUTS: joinEnvPath(`${textemplateDir}`, `${process.env.TEXINPUTS}`) } });

Without the previous TEXINPUTS, latex throws errors like no article.cls available.

The problem at the moment is that it says "Success!" and no file is produced. Do you know what could be happening?

src/exporto0o.ts

mokeyish · 2023-06-07T21:23:45Z

Hey @mokeyish I think we are close! I changed the variable to this:
 await exec(cmd, { cwd: variables.currentDir, env: { TEXINPUTS: joinEnvPath(`${textemplateDir}`, `${process.env.TEXINPUTS}`) } }); 
Without the previous TEXINPUTS, latex throws errors like no article.cls available.

The problem at the moment is that it says "Success!" and no file is produced. Do you know what could be happening?

Are you sure it's an environment variable issue? Obsidian's environment variables are only the most basic, and we have to see what is missing and add the rest.

just like

obsidian-enhancing-export/src/main.ts

Lines 32 to 39 in f0ce1d0

    
           case 'darwin': { 
        
             let envPath = process.env['PATH']; 
        
             const extraBins = ['/usr/local/bin', '/Library/TeX/texbin']; 
        
             for (const bin of extraBins) { 
        
               if (envPath.includes(bin)) continue; 
        
               envPath = joinEnvPath(bin, envPath); 
        
             } 
        
             env.PATH = envPath;

mokeyish · 2023-06-09T18:14:07Z

I'm on windows and can't test latex. Let's do this for now, and optimize it slowly later.

universvm · 2023-06-09T18:25:40Z

Nice, is this good to be merged then?

mokeyish · 2023-06-10T00:35:05Z

Nice, is this good to be merged then?

It cannot be merged yet, latex templates are currently hard-coded. We should make it configurable.

universvm · 2023-06-10T07:09:48Z

Nice, is this good to be merged then?

It cannot be merged yet, latex templates are currently hard-coded. We should make it configurable.

There is a dropdown menu. You made this - I just modified the TEXINPUTS from your commit

src/exporto0o.ts

src/export_templates.ts

universvm · 2023-06-10T07:26:41Z

Sorry I thought I fixed the conflicts on merge... give me a minute.

src/ui/ExportDialog.tsx

universvm · 2023-06-10T07:35:17Z

Ok I can add your changes but as I mentioned before the app does not work. It loads forever when exporting.

mokeyish · 2023-06-10T07:35:52Z

@universvm Hi Leo, Please have a look at the latest code, now you can add Dropdown through configuration.

Here is the full command template.
{
    name: 'PDF',
    type: 'pandoc',
    arguments:
      '-f markdown --resource-path="${currentDir}" --resource-path="${attachmentFolderPath}" --lua-filter="${luaDir}/pdf.lua" ${ options.textemplate ? `--template="${pluginDir}/textemplate/${options.textemplate}"` : `` } --embed-resources --standalone --metadata title="${currentFileName}" -s -o "${outputPath}" -t pdf',
    customArguments: '--pdf-engine=typst',
    optionsMeta: {
      'textemplate': {
        title: 'Latex Template',
        type: 'dropdown',
        options: [
          { name: 'None', value: null },//
          { name: 'Dissertation', value: 'dissertation.tex' },
          { name: 'Academic Paper', value: 'academic.tex' }
        ]
      }
    },
    extension: '.pdf',
  }
There are two points above.
Add following snippet to arguments
${ options.textemplate ? `--template="${pluginDir}/textemplate/${options.textemplate}"` : `` }
Add following snippet to optionsMeta
{
  optionsMeta: {
   'textemplate': {
     title: 'Latex Template',
     type: 'dropdown',
     options: [
       { name: 'None', value: null },//
       { name: 'Dissertation', value: 'dissertation.tex' },
       { name: 'Academic Paper', value: 'academic.tex' }
     ]
   }
 }
}
obsidian-enhancing-export/tests/renderTemplate.spec.ts

Lines 10 to 18 in e08b602

test('test Template rendering options.textemplate', async () => {

expect(renderTemplate('pandoc ${ options.textemplate ? `--template="${options.textemplate}"` : `` }',

{ options: { textemplate: 'dissertation.tex' } }))

.toBe('pandoc --template="dissertation.tex"');

expect(renderTemplate('pandoc ${ options.textemplate ? `--template="${options.textemplate}"` : `` }',

{ options: { textemplate: null } }))

.toBe('pandoc ');

});

@universvm Hi Leo,
With the latest code, Adding latex dropdown just change the export template definition above

universvm · 2023-06-10T07:37:55Z

@mokeyish see the code now. I did what you said but the plugin does not work. Unfortunately I cannot work on this anymore.

If you can fix the bug feel free to merge. If not close this issue and I will publish my templates somewhere else.

mokeyish · 2023-06-10T07:49:37Z

I also don't really want to spend time on this project 😂. I wrote this project because I couldn't find a suitable tool for sharing notes and wanted to export it to the hugo blog, so I spent a few days writing such a plugin.

If you don't want to continue to toss. You can put the final TEXINPUTS value and the final export command. Check it out if I have time.

universvm · 2023-06-13T13:25:46Z

@mokeyish Addressed all the changes you had made + fixed a small bug.

The templates will be published in here: https://github.com/universvm/academic-pandoc-templates

I will keep this plugin updated with the templates. The repository above contains tutorials on how to use the templates etc..

mokeyish · 2023-06-16T13:50:30Z

Let's close this PR, and could you resubmit a new one base on the branch https://github.com/mokeyish/obsidian-enhancing-export/tree/dev ?

please use git rebase to keep git logs clean. Here is the git rebase documentation: https://git-scm.com/docs/git-rebase . Or use git gui such as https://www.syntevo.com/smartgit/, I pretty like smartgit.

mokeyish · 2023-06-16T20:29:44Z

Adding a screenshot, we can see that the commit log without rebase looks very confusing.

mokeyish · 2023-06-17T08:53:11Z

src/exporto0o.ts

  // show progress
  progress.setMessage(lang.preparing(outputFileFullName));
  beforeExport && beforeExport();
  progress.show();

  const pandocPath = getPlatformValue(globalSetting.pandocPath) ?? 'pandoc';

-  const cmdTpl =
+  let cmdTpl =


These changes are unnecessary. The template render function will do this automatically. Do you understand?

The whole changes of this file are also unnecessary.

universvm · 2023-06-17T09:55:41Z

Hi @mokeyish

Could you have a look now? I reverted the changes you mentioned and tested.

If all is good I will clean up the commit history. If not let me know I can change

universvm · 2023-06-17T10:43:43Z

@mokeyish I am having problems with conflicts squashing the commits. Can we squash everything into one when merging to dev?

mokeyish · 2023-06-17T10:46:22Z

@mokeyish I am having problems with conflicts squashing the commits. Can we squash everything into one when merging to dev?

No need to resolve conflicts. create a new branch to applly your changes.

universvm · 2023-06-17T13:26:56Z

@mokeyish I am having problems with conflicts squashing the commits. Can we squash everything into one when merging to dev?

No need to resolve conflicts. create a new branch to applly your changes.

Ah ok! Will probably do these tomorrow :)

Add exporting to latex template

fe82a5b

universvm commented Jun 5, 2023

View reviewed changes

src/export_command_templates.ts Outdated Show resolved Hide resolved

universvm mentioned this pull request Jun 5, 2023

Adding latex template support #66

Closed

Fix local templates

7ba80e7

mokeyish reviewed Jun 5, 2023

View reviewed changes

src/ui/ExportDialog.tsx Outdated Show resolved Hide resolved

mokeyish reviewed Jun 5, 2023

View reviewed changes

src/ui/ExportDialog.tsx Outdated Show resolved Hide resolved

Add neurips

4746548

universvm added 3 commits June 6, 2023 12:27

Add latex neurips

957088d

Delete DS_Store

ae134cc

Add tex templates

cd3d13c

universvm added 3 commits June 7, 2023 17:21

Merge main

e9c500d

Add TEXINPUTS

b561031

Add TEXINPUTS variable from templatedir

d7826b8

mokeyish reviewed Jun 7, 2023

View reviewed changes

src/exporto0o.ts Outdated Show resolved Hide resolved

src/exporto0o.ts Outdated Show resolved Hide resolved

src/exporto0o.ts Outdated Show resolved Hide resolved

Fix javascript

c559073

universvm marked this pull request as ready for review June 9, 2023 18:04

Repository owner deleted a comment from universvm Jun 9, 2023

Remove double template dropwdown

92ef758

mokeyish reviewed Jun 10, 2023

View reviewed changes

src/exporto0o.ts Outdated Show resolved Hide resolved

mokeyish reviewed Jun 10, 2023

View reviewed changes

src/export_templates.ts Show resolved Hide resolved

mokeyish reviewed Jun 10, 2023

View reviewed changes

src/ui/ExportDialog.tsx Outdated Show resolved Hide resolved

Add monkeyish changes

d778f59

universvm added 2 commits June 13, 2023 14:22

Update with latest templates

7515a91

Remove old configs

5d33710

Fix CSLreference

545e724

universvm requested a review from mokeyish June 14, 2023 14:51

mokeyish closed this Jun 16, 2023

mokeyish mentioned this pull request Jun 17, 2023

✨ Support select Latex template #84

Closed

mokeyish reviewed Jun 17, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add exporting to latex template #80

Add exporting to latex template #80

universvm commented Jun 5, 2023

mokeyish commented Jun 5, 2023

universvm commented Jun 5, 2023

universvm commented Jun 6, 2023 •

edited

Loading

mokeyish commented Jun 7, 2023

universvm commented Jun 7, 2023 •

edited

Loading

universvm commented Jun 7, 2023 •

edited

Loading

mokeyish commented Jun 7, 2023

mokeyish commented Jun 7, 2023

universvm commented Jun 7, 2023 •

edited

Loading

mokeyish commented Jun 7, 2023 •

edited

Loading

universvm commented Jun 7, 2023 •

edited

Loading

mokeyish commented Jun 7, 2023

mokeyish commented Jun 7, 2023

universvm commented Jun 7, 2023 •

edited

Loading

mokeyish commented Jun 7, 2023

mokeyish commented Jun 9, 2023

universvm commented Jun 9, 2023

mokeyish commented Jun 10, 2023

universvm commented Jun 10, 2023 •

edited

Loading

universvm commented Jun 10, 2023

universvm commented Jun 10, 2023

mokeyish commented Jun 10, 2023

universvm commented Jun 10, 2023

mokeyish commented Jun 10, 2023

universvm commented Jun 13, 2023

mokeyish commented Jun 16, 2023

mokeyish commented Jun 16, 2023

mokeyish Jun 17, 2023

mokeyish Jun 17, 2023

universvm commented Jun 17, 2023

universvm commented Jun 17, 2023

mokeyish commented Jun 17, 2023

universvm commented Jun 17, 2023

Add exporting to latex template #80

Add exporting to latex template #80

Conversation

universvm commented Jun 5, 2023

mokeyish commented Jun 5, 2023

universvm commented Jun 5, 2023

universvm commented Jun 6, 2023 • edited Loading

mokeyish commented Jun 7, 2023

universvm commented Jun 7, 2023 • edited Loading

universvm commented Jun 7, 2023 • edited Loading

mokeyish commented Jun 7, 2023

mokeyish commented Jun 7, 2023

universvm commented Jun 7, 2023 • edited Loading

mokeyish commented Jun 7, 2023 • edited Loading

universvm commented Jun 7, 2023 • edited Loading

mokeyish commented Jun 7, 2023

mokeyish commented Jun 7, 2023

universvm commented Jun 7, 2023 • edited Loading

mokeyish commented Jun 7, 2023

mokeyish commented Jun 9, 2023

universvm commented Jun 9, 2023

mokeyish commented Jun 10, 2023

universvm commented Jun 10, 2023 • edited Loading

universvm commented Jun 10, 2023

universvm commented Jun 10, 2023

mokeyish commented Jun 10, 2023

universvm commented Jun 10, 2023

mokeyish commented Jun 10, 2023

universvm commented Jun 13, 2023

mokeyish commented Jun 16, 2023

mokeyish commented Jun 16, 2023

mokeyish Jun 17, 2023

Choose a reason for hiding this comment

mokeyish Jun 17, 2023

Choose a reason for hiding this comment

universvm commented Jun 17, 2023

universvm commented Jun 17, 2023

mokeyish commented Jun 17, 2023

universvm commented Jun 17, 2023

universvm commented Jun 6, 2023 •

edited

Loading

universvm commented Jun 7, 2023 •

edited

Loading

universvm commented Jun 7, 2023 •

edited

Loading

universvm commented Jun 7, 2023 •

edited

Loading

mokeyish commented Jun 7, 2023 •

edited

Loading

universvm commented Jun 7, 2023 •

edited

Loading

universvm commented Jun 7, 2023 •

edited

Loading

universvm commented Jun 10, 2023 •

edited

Loading