man/tumblr.5.ronn in tumblr-rb-1.3.0 vs man/tumblr.5.ronn in tumblr-rb-2.0.0.alpha
- old
+ new
@@ -4,101 +4,88 @@
## SYNOPSIS
---
title: A typical Tumblr post
state: queue
- publish-on: next tuesday
tags: unix, manpages
format: markdown
---
-
- This will create a *Regular* type of post on Tumblr.com. It's so easy.
- That bit up at the top is called YAML frontmatter, and it just gives the
+
+ This will create a *Regular* type of post on Tumblr.com. It's so easy.
+ That bit up at the top is called YAML frontmatter, and it just gives the
post a bit of metadata, so publishing options are more flexible.
- They correspond to the Tumblr API. This post will be added to your Tumblr
- queue, to be published next Tuesday, tagged with "unix" and "manpages",
+ They correspond to the Tumblr API. This post will be added to your Tumblr
+ queue, to be published next Tuesday, tagged with "unix" and "manpages",
and formatted in markdown.
-
+
## DESCRIPTION
-Any file can be published to Tumblr.com as a <i>Regular</i> post, but if you add a bit of YAML frontmatter (<yaml.org>) to the file, you can tell Tumblr exactly what you want to do.
+Any plaintext file can be published to Tumblr.com as a <i>Text</i> post, but if you add a bit of YAML frontmatter (<yaml.org>) to the file, you can tell Tumblr exactly what you want to do.
YAML frontmatter beings with `---` on a single line, followed by YAML, ending with another `---` on a single line, e.g.
---
type: quote
source: Billy Shakespeare
state: draft
tags: hamlet, shakespeare
---
"To be or not to be."
-
-Understood YAML parameters are documented and taken from the Tumblr API: http://www.tumblr.com/docs/en/api#api_write
+Understood YAML parameters are documented and taken from the Tumblr API: http://www.tumblr.com/docs/en/api/v2#posting
+
## BASIC PARAMETERS
These YAML parameters are available for all posts
* `type`:
- `regular`, `photo`, `link`, `quote`, `conversation`, `video`, `audio`
+ `text`, `photo`, `quote`, `link`, `chat`, `audio`, `video`
Will take a guess if omitted.
See _POST-TYPE SPECIFIC PARAMETERS_ below.
* `state`:
- `published`, `draft`, `queue`, `submission`
-
+ `published`, `draft`, `queue`, `private`
+
* `format`:
`html` or `markdown`
-
-* `tags`:
+ Defaults to `markdown`
+
+* `tags`:
Comma-separated list of tags.
-
+
* `date`:
Post date.
-
-* `private`:
- If the post should be marked private.
-
+
* `slug`:
A custom string to appear in the post's url.
-
-* `group`:
- ID for a secondary blog.
-
-* `generator`:
- Short description of the publishing application.
-
-* `send-to-twitter`:
- Twitter status update to make if the tumblelog has enabled it.
-
-* `publish-on`:
- If the post state is 'queue', publish on this date
-
+
+* `tweet`:
+ Manages the autotweet (if enabled) for this post
+
## POST-TYPE SPECIFIC PARAMETERS
These are parameters that are available for specific types of posts.
-* `regular`:
- `title`
-
+* `text`:
+ `title`, `body`
+
* `photo`:
- `caption`, `click-through-url`
-
+ `caption`, `link`, `source`, `data`
+
* `quote`:
- `source`
-
+ `quote`, `source`
+
* `link`:
- `name`, `description`
-
-* `conversation`:
- `title`
-
-* `video`:
- `title`,`caption`
-
+ `title`, `url`, `description`
+
+* `chat`:
+ `title`,`conversation`
+
* `audio`:
- `caption`
-
+ `caption`, `external_url`, `data`
+
+* `video`:
+ `caption`, `embed`, `data`
+
## SEE ALSO
tumblr(1), markdown(5)
-
\ No newline at end of file