Skip to content

vedang/pdftoolswiki

Repository files navigation

The PDF Tools Wiki

This is the PDF Tools Wiki. It is built from the contents of the README.org file in https://github.com/vedang/pdf-tools using the ox-neuron exporter.

The content of this Wiki will always be in sync with the source (maintained in the pdf-tools repo in README.org and docs/*.org files).

Contributing to the Wiki

There are two ways in which readers can contribute to the Wiki:
  1. From the website:
    • Go to https://pdftools.wiki/impulse.html
    • Search for the note you want to edit.
    • Click the edit button at the bottom of the post. This will bring you to the right note in Github.
    • Fork the Wiki to your account, make the changes and submit a PR.
  2. From the pdf-tools source:
    • Clone the pdf-tools source to your account.
    • Make the relevant changes to the README.org file or to any of the docs/*.org files.
    • Submit a PR

Editing org files: Special headers and link types

If you are creating new headings in the source files (org-mode files), you need to create the ID property for the new headings. This can be done by running M-x org-id-get-create on the new heading.

For referencing different sections across the content, you should use id: links. This is the canonical way to link two subtrees in org-mode. You can copy an ID link by going to the subtree you want to link to and running the command org-store-link (with C-u C-u C-c l). Once you have captured a link, you can paste the link by running the command org-insert-link (with C-c C-l). Users of org-roam will be familiar with this.

Advanced link types: Parent/Child links

If you are not a user of org-brain, you can safely ignore this section.

If you are a user of org-brain, then you’ll be happy to know that ox-neuron (and therefore this Wiki) also supports parent/child relationships. You can add parent/child relationships between subtrees using the `brain-child:` and `brain-parent:` link types.