App::org2wp - Publish Org document to WordPress as blog post
This document describes version 0.008 of App::org2wp (from Perl distribution App-org2wp), released on 2019-12-26.
org2wp(%args) -> [status, msg, payload, meta]
Publish Org document to WordPress as blog post.
This is originally a quick hack because I couldn't make Lhttps://github.com/punchagan/org2blog on my Emacs installation to work after some update.
org2wp uses the same format as
org2blog, but instead of being an Emacs package, it is a CLI script written in Perl.
~/org2wp.conf containing the API credentials, e.g.:
proxy=https://YOURBLOGNAME.wordpress.com/xmlrpc.php username=YOURUSERNAME password=YOURPASSWORD
You can also put multiple credentials in the configuration file using profile sections, e.g.:
[profile=blog1] proxy=https://YOURBLOG1NAME.wordpress.com/xmlrpc.php username=YOURUSERNAME password=YOURPASSWORD [profile=blog2] proxy=https://YOURBLOG2NAME.wordpress.com/xmlrpc.php username=YOURUSERNAME password=YOURPASSWORD
and specify which profile you want using command-line option e.g.
To create a blog post, write your Org document (e.g. in
post1.org) using this format:
#+TITLE: Blog post title #+CATEGORY: cat1, cat2 #+TAGS: tag1,tag2,tag3 Text of your post ... ...
% org2wp post1.org
this will create a draft post. To publish directly:
% org2wp --publish post1.org
Note that this will also modify your Org file and insert this line at the top:
where 1234 is the post ID retrieved from the server when creating the post.
After the post is created, you can update using the same command:
% org2wp post1.org
You can use
--publish to publish the post, or
--no-publish to revert it to draft.
To set more attributes:
% org2wp post1.org --comment-status open \ --extra-attr ping_status=closed --extra-attr sticky=1
Another example, to schedule a post in the future:
% org2wp post1.org --schedule 20301225T00:00:00
This function is not exported.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
comment_status => str (default: "closed")
Whether to allow comments (open) or not (closed).
extra_attrs => hash
Set extra post attributes, e.g. ping_status, post_format, etc.
filename* => filename
Path to Org document to publish.
password* => str
proxy* => str
publish => bool
Whether to publish post or make it a draft.
--extra-attr post_status=published, while
--no-publishis equivalent to
schedule => date
Schedule post to be published sometime in the future.
--publish --extra-attr post_date=DATE. Note that WordPress accepts date in the
YYYYMMDD"T"HH:MM:SSformat, but you specify this option in regular ISO8601 format. Also note that time is in your chosen local timezone setting.
username* => str
-dry_run => bool
Pass -dry_run=>1 to enable simulation mode.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/App-org2wp.
Source repository is at https://github.com/perlancar/perl-App-org2wp.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-org2wp
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
This software is copyright (c) 2019, 2017, 2016 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.