mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

improve docs of template variables

Browse source
This commit is contained in:
Joey Hess 2020-06-24 13:23:16 -04:00
parent b38cc371ad
commit 57edd81849
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/git-annex-importfeed.mdwn
View file

@ -34,7 +34,25 @@ To make the import process add metadata to the imported files from the feed,
The default template is '${feedtitle}/${itemtitle}${extension}'
Other available variables for templates: feedauthor, itemauthor, itemsummary, itemdescription, itemrights, itemid, itempubdate, title, author
The available variables in the template include these that
are information about the feed: feedtitle, feedauthor
And these that are information about individual items in the feed:
itemtitle, itemauthor, itemsummary, itemdescription, itemrights,
itemid.
Also, title is itemtitle but falls back to feedtitle if the item has no
title, and author is itemauthor but falls back to feedauthor.
(All of the above are also added as metadata when annex.genmetadata is
set.)
The template also has some variables for when an item was published.
itempubdate (YYY-MM-DD or if the feed's date cannot be parsed, the raw
value from the feed).
(These use the UTC time zone, not the local time zone.)
* `--relaxed`, `--fast`, `--raw`