Skip to content
This repository has been archived by the owner on Sep 20, 2023. It is now read-only.
/ aTbRef-Docset Public archive

A Tinderbox Reference File (aTbRef) packaged as a Dash docset

License

Notifications You must be signed in to change notification settings

samvtran/aTbRef-Docset

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A Tinderbox Reference File Dash Docset

This repository contains a Dash docset for aTbRef, an invaluable resource for Tinderbox users.

Quickstart

  • Download aTbRef.docset.zip from the latest release in the Releases tab
  • Unzip the docset, put it somewhere safe, and open it in Dash
  • Enjoy!

What Works

  • Dark mode
  • Internal links (if any don't resolve correctly, please open an issue 🙏)
  • Open Online Page links to the online version at https://acrobatfaq.com/atbref9/

TODO

  • Ensure all links can resolve interally
  • Host a docset feed
  • Verify page types (most are guide)

Modifications

The following modifications have been made to aTbRef-9.tbx file included in this repo:

  • here quicklink has been removed since it's not particularly useful inside Dash
  • Google Analytics, Google search, and DuckDuckGo search have been disabled.

Generating Your Own Docset

Follow the directions at Obtaining the aTbRef source TBX file to prepare a full HTML export of the aTbRef file.

After generating an export, open the DocsetGenerator project in Xcode. Edit the Run scheme of the project to include two environment variables:

  • TBX_REF_PATH - The absolute path to aTbRef HTML export; e.g., /Users/me/Documents/aTbRef Export
  • TBX_DOCSET_PATH - The absolute path to this repository's aTbRef.docset folder; e.g., /Users/me/Documents/aTbRef-Docset/aTbRef.docset

Run DocsetGenerator to generate the necessary files.

Finally, open the aTbRef.docset package with Dash to install the local docset.

Licenses

DocsetGenerator is covered by the MIT license included in the LICENSE file.

All textual content is licensed as below:

A Tinderbox Reference File ('aTbRef') by Mark Anderson is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Mark Anderson should be acknowledged as the creator of this Tinderbox document (plus associated images, HTML export templates, etc.) and website produced from it.

Parts of this document that directly quote copyright materials from Eastgate Systems Inc., e.g. the manual, release notes, etc., and do so with permission from Eastgate Systems Inc.

The input of the following (as further explained at 'Origin of aTbRef') should be acknowledged: Mark Bernstein & Eastgate Systems Inc., Benoit Pointet, and Matt Neuburg.