Skip to content

Commit

Permalink
Add tdn and ctan keywords
Browse files Browse the repository at this point in the history
See README for more info about these
  • Loading branch information
egeerardyn committed Mar 26, 2016
1 parent 7e6cc76 commit 299e224
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

This is the initial version.
You can only query your local documentation with the keyword `td`.

## Version 1.0.0

Two new keywords added:
- `tdn <PKG>` downloads the documentation from texdoc.net
- `ctan <PKG` opens the CTAN page of the package
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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](texdocnet).
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][texdocnet].

## Installation

Expand All @@ -13,19 +13,30 @@ Installation is pretty easy:

## Usage

### Keyword `td`

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

![Example `td texdoc`](img/example.png)

Internally, the [texdoc][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][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][texdocnet].

### Keyword `ctan`

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

## Links

- [Alfred forum topic](http://www.alfredforum.com/topic/8705-texdoc-workflow/)
- [Packal page](http://www.packal.org/workflow/texdoc)

[alfred2]: https://www.alfredapp.com
[CTAN]: https://www.ctan.org
[mactex]: https://tug.org/mactex/
[texdoc]: https://www.tug.org/texdoc/
[texdocnet]: http://texdoc.net
Binary file modified TeXdoc.alfredworkflow
Binary file not shown.

0 comments on commit 299e224

Please sign in to comment.