alfred-texdoc's Introduction

TeXdoc workflow for Alfred

This repository contains a Workflow for Alfred 2 that allows you to easily open the documentation of your TeX distribution.

It makes use of your local LaTeX installation, so searching the documentation is really fast and does not depends on websites such as texdoc.net.

Installation

Installation is pretty easy:

Download TeXdoc.alfredworkflow from the latest release.
Open the workflow and install it in Alfred.

Alternatively, if you want to build from the repository, run the following instructions in your working directory

make alfredworkflow # build the workflow
make install  # install into Alfred

Usage

Keyword `td`

To use the workflow, type td in your Alfred, followed by the name of the documentation you want to consult.

Internally, the texdoc command is used to query the documentation present on your local computer. Hence, the query in the figure above will open the documentation of texdoc in your default viewer.

Keyword `tdn`

If you type tdn followed by a package name into Alfred, you will download the corresponding documentation from texdoc.net.

Keyword `ctan`

This keyword opens the CTAN page for the package you specify, i.e. https://www.ctan.org/pkg/<name>.

Links

alfred-texdoc's People

Contributors

Stargazers

Watchers

alfred-texdoc's Issues

Don't store build artefact in repository

I utterly dislike having this ugly .alfredworkflow file in my git repository.

Since it is just a ZIP file, probably, it makes sense to use some of the techniques from either:

to solve this.

In any case, the build artefact should still be available from the releases page.

Update for macOS 10.12.4 or newer

When installing alfred-texdoc on macOS 10.12.4 and alfred 3.5.1, alfred complains with

This workflow contains a python library incompatible with macOS Sierra 10.12.4+

and points the user to following webpage: https://www.alfredapp.com/help/troubleshooting/incompatible-python-workflow-library/

Would you mind updating your workflow on http://www.packal.org/workflow/texdoc?

does not work on python3

Latest macOS comes with python3 by default but the scripts are python2 only. Needs updating of all the python scripts and the script filter.

Outdated version in packal

Version available in packal is 2.0.0, While the latest release is 2.1.0.

Thank you for the workflow.

Interactive filter

It would be really nice to make this workflow interactive, i.e. transform the output from texdoc --list ... to XML such that Alfred can display it to the user.

Output from that command looks something like:

1 /usr/local/texlive/2015/texmf-dist/doc/latex/pgfplots/pgfplots.pdf
   = Package manual
 2 /usr/local/texlive/2015/texmf-dist/doc/latex/pgfplots/TeX-programming-notes.pdf
 3 /usr/local/texlive/2015/texmf-dist/doc/context/third/pgfplots/pgfplotsexample-context.pdf
 4 /usr/local/texlive/2015/texmf-dist/doc/plain/pgfplots/pgfplotsexample-plain.pdf
 5 /usr/local/texlive/2015/texmf-dist/doc/latex/pgfplots/pgfplotsexample.pdf
 6 /usr/local/texlive/2015/texmf-dist/doc/latex/pgfplots/pgfplotstable.pdf
 7 /usr/local/texlive/2015/texmf-dist/doc/latex/pgfplots/pgfplotstodo.pdf
 8 /usr/local/texlive/2015/texmf-dist/doc/generic/pgfplots/README
   = Readme

Recommend Projects