Skip to content

Offline Reference

Ben Fry edited this page Jan 4, 2023 · 3 revisions

Since the start of the project, we've included an offline copy of the reference with the Processing download. This was used for “Find in Reference” and the links in the Help menu. This is especially helpful/important for people with lower internet availability (i.e for situations where internet is disconnected, slow, or expensive).

When the site redesign launched in 2021, the size of the reference.zip file jumped from 4.2 MB to about 100 MB, which meant it was far too large to include it with the download. For the initial release of 4.0 in August 2022, the offline reference was removed and we linked to the online reference.

Downloading the offline reference

With Processing 4.1 (late November 2022), a “Download Offline Reference” item was added to the Help Menu, which downloads an offline copy. This feature creates a file called reference.zip in the sketchbook. If that file is present, then the Help menu links and Find in Reference will use that copy of the reference. If it is not present, online URLs will be used.

If you have that reference.zip file, you can also manually copy it to another sketchbook. Put reference.zip in the root of your sketchbook and restart Processing so that it picks up the new file. For instance, in a class situation, you might put the file on a shared server and tell people where to find it.

Size of the downloaded file

The download size is around 66 MB. We would still like it to be smaller, and if we can get it down to around 10 MB, we can include it in the download again, and get rid of the “Download Offline Reference” option.

Needing to manually download the reference is not an ideal situation and we're not happy with it: for many users, being offline is when they realize they need an offline reference. But at least the current situation is better than no options at all, or increasing the download size by more than 25%.

There's still work to do

This is a high priority for us. While many people have no idea that the offline reference is available at all, there are also many people who rely on it, particularly those in important communities for us (users outside the US, limited internet resources, and so on).