Navigation

  • index
  • modules |
  • next |
  • previous |
  • Alfred-Workflow 1.17 documentation »

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.

  • Workflow setup and skeleton
  • Including 3rd party libraries
  • Persistent data
    • Caching data
    • Storing data
    • Settings
    • Keychain access
    • A note on Script Behaviour
  • Searching/filtering data
    • Restricting results
    • Diacritic folding
    • Matching rules
  • Retrieving data from the web
  • Notifications
    • Usage
  • Background processes
  • Self-updating
    • GitHub releases
    • Configuration
    • Usage
    • Under the hood
    • Version numbers
  • Versioning and migration
    • Setting a version number
    • Version numbers
    • 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
    • Other Gotchas
    • Further information

Logo

Alfred-Workflow

A helper library for creating Alfred 2 workflows.

Navigation

  • Supported software
  • Installation
  • Tutorial
  • User Manual
    • Workflow setup and skeleton
    • Including 3rd party libraries
    • Persistent data
    • Searching/filtering data
    • Retrieving data from the web
    • Notifications
    • Background processes
    • Self-updating
    • Versioning and migration
    • System icons
    • “Magic” arguments
    • Serialization of stored/cached data
    • Encoded strings and Unicode
  • API Documentation
  • Script Filter Results and the XML Format
  • Workflows using Alfred-Workflow
  • Quick Index

Related Topics

  • Documentation overview
    • Previous: Tutorial Part 2: Creating a Distribution-Ready Pinboard Workflow
    • Next: Workflow setup and skeleton

Quick search

Enter search terms or a module, class or function name.

Donate

Consider supporting the author on Gratipay:

©2016, Dean Jackson. | Powered by Sphinx 1.3.5 & Alabaster 0.7.7