search

mejo- / pandoc

Nextcloud app to convert text files using pandoc
GNU Affero General Public License v3.0
4 stars 0 forks source link

Nothing showing up. Readme needs more Info, #8

Closed z0rgster closed 1 year ago

z0rgster commented 1 year ago

Hi,

I'm very interested in using Pandoc with Nextcloud, but I'm not sure if I set up everything correctly. I have a fully working Nextcloud docker instance running on v25.0.2. I stumbled upon your addon in the store and immediately needed to try it. Soon I realized that pandoc itself obviously doesn't come with the addon, so I added it to the Dockerfile (apt-get install pandoc) and rebuilt the image. What I am missing is any information on how the addon should work normally. Should I get a "Convert with Pandoc" in the context menu? Should I look in the sidebar? Do I have to use the CLI? At the moment I have no info on what I should look for and what might have gone wrong. A Usage section in the Readme would be a great addition.

I would gladly appreciate any help :)

mejo- commented 1 year ago

Hey @z0rgster, thanks for your interest in the app.

To be honest, for now the app is more of an integration app to be used by other apps. It doesn't have a UI itself. I developed it to allow converting pages from the Collectives app to other formats. The pandoc app registers an extra action for the Collectives app to do so.

What the app can do so far:

Backend calls to /apps/pandoc/convertFile?fileId=<fileId>&to=<format>&from=<format> will return the converted content of the file in question. Query params to (default plain or app setting default_output_format) and from (default gfm - github flavor markdown) are optional.

Opening /apps/pandoc?fileIds=<list_of_fileIds_separated_by_comma> in the browser converts all passed files to the format configured as default by app setting default_output_format.

If the pandoc and the Collectives app are installed, you see an extra action "Convert with pandoc" in the three-dot actions menu of the startpage of a collective.

mejo- commented 1 year ago

What would you expect the app to do for you? Which kind of documents to you want to convert, and into which format? Is it for markdown files (as created by Nextcloud Text)? Or also for other files? I'm curious to learn about your usecase.

mejo- commented 1 year ago

And in case you feel like updating the README.md with some extra documentation about the functionalities of the app, a pull request would be highly appreciated :relaxed:

tilleule commented 1 year ago

Sorry for chiming in, I too just found your app and was delighted! I had tinkered with workflows for NC in the past but to no avail.

My workflow consists of markdown files I convert into pdf, but I'm using custom templates and a lua filter, so I'd need some way of passing command line arguments to the pandoc conversion. For examle in vim I use pandoc -o %:r.pdf % -s --template=homework --pdf-engine=tectonic --lua-filter=lilypond.lua --filter=pandoc-wrapfig.py.

It would be just wonderful to be able to start such conversion from the web UI.