Alfred-Workflow
  • Installation
    • pip / PyPi
    • GitHub
  • Tutorial
    • Part 1: A Basic Pinboard Workflow
    • Part 2: A Distribution-Ready Pinboard Workflow
  • User Manual
    • Supported OS X versions
    • Workflow setup and skeleton
    • Including 3rd party libraries
    • Persistent data
    • Searching/filtering data
    • Retrieving data from the web
    • Background processes
    • Self-updating
    • Versioning and migration
    • System icons
    • “Magic” arguments
    • Serialization of stored/cached data
    • Encoded strings and Unicode
  • Alfred-Workflow API
    • The Workflow Object
    • Fetching Data from the Web
    • Background Tasks
    • Self-Updating
    • Serialization
    • Index
  • Script Filter Results and the XML Format
    • XML format / available parameters
    • Basic example
    • Item parameters
  • Workflows using Alfred-Workflow
    • Adding your own workflow to the list
 
Alfred-Workflow
  • Docs »
  • User Manual
  • View page source

User ManualΒΆ

This section describes how to use the features of Alfred-Workflow.

If you’re new to writing workflows or coding in general, start with the Tutorial.

Tip

If you’re writing a workflow that uses data from the system (e.g. from files/the filesystem or via command-line programs called via subprocess), please read Encoded strings and Unicode, which describes how to handle data from sources other than Alfred-Workflow’s libraries.

  • Supported OS X versions
  • Workflow setup and skeleton
  • Including 3rd party libraries
  • Persistent data
    • Caching data
      • Clearing cached data
    • Storing data
      • Clearing stored data
    • Settings
    • Keychain access
    • A note on Script Behaviour
  • Searching/filtering data
    • Restricting results
    • Diacritic folding
      • “Smart” punctuation
    • Matching rules
  • Retrieving data from the web
  • Background processes
  • Self-updating
    • GitHub releases
    • Configuration
    • Usage
    • Under the hood
    • Version numbers
  • Versioning and migration
    • Setting a version number
    • Version numbers
      • Semantic versioning
    • First run/migration
  • System icons
    • List of icons
  • “Magic” arguments
    • Customising magic arguments
  • Serialization of stored/cached data
    • Built-in serializers
    • Managing serializers
    • Serializer interface
  • Encoded strings and Unicode
    • TL;DR
    • String types
    • Normalization
      • TL;DR
      • Why does normalization matter?
      • Normalization with Alfred-Workflow
    • Further information
Next Previous

© Copyright 2015, Dean Jackson.

Sphinx theme provided by Read the Docs
Fork me on GitHub