diff --git a/docs/consumption.rst b/docs/consumption.rst index 6e5bd8574..28adf65e7 100644 --- a/docs/consumption.rst +++ b/docs/consumption.rst @@ -45,19 +45,25 @@ you name the file right, it'll automatically set some values in the database for you. This is is the logic the consumer follows: 1. Try to find the correspondent, title, and tags in the file name following + the pattern: ``Date - Correspondent - Title - tag,tag,tag.pdf``. Note that + the format of the date is **rigidly defined** as ``YYYYMMDDHHMMSSZ``. The + ``Z`` is for "Zulu time" AKA "UTC". +2. If that doesn't work, we skip the date and try this pattern: the pattern: ``Correspondent - Title - tag,tag,tag.pdf``. -2. If that doesn't work, try to find the correspondent and title in the file +3. If that doesn't work, we try to find the correspondent and title in the file name following the pattern: ``Correspondent - Title.pdf``. -3. If that doesn't work, just assume that the name of the file is the title. +4. If that doesn't work, just assume that the name of the file is the title. So given the above, the following examples would work as you'd expect: +* ``20150314000700Z - Some Company Name - Invoice 2016-01-01 - money,invoices.pdf`` * ``Some Company Name - Invoice 2016-01-01 - money,invoices.pdf`` * ``Another Company - Letter of Reference.jpg`` * ``Dad's Recipe for Pancakes.png`` These however wouldn't work: +* ``2015-03-14 00:07:00 UTC - Some Company Name, Invoice 2016-01-01, money, invoices.pdf`` * ``Some Company Name, Invoice 2016-01-01, money, invoices.pdf`` * ``Another Company- Letter of Reference.jpg``