The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-pod2wp-0.005
River stage one • 1 direct dependent • 1 total dependent
++
/ pod2wp

NAME

pod2wp - Publish POD document to WordPress as blog post

VERSION

This document describes version 0.005 of pod2wp (from Perl distribution App-pod2wp), released on 2021-05-25.

SYNOPSIS

Usage:

 % pod2wp [--comment-status=s] [--config-path=path | -c]
     [--config-profile=profile | -P] [--debug] [--dry-run | -n]
     [--extra-attr key=s] [--extra-attrs-json=s] [--format=name] [--json]
     [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
     [--no-publish] [--nopublish] [--page-result[=program]] [--password=s]
     [--proxy=s] [--publish] [--quiet] [--schedule=s] [--trace]
     [--username=s] [--verbose] [--view-result[=program]] <filename>

DESCRIPTION

This is like org2wp except that instead of Org as the document format, this program uses POD.

To use this program, first create ~/pod2wp.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. --config-profile blog1.

To create a blog post, write your POD document (e.g. in post1.pod) using this format:

 =for pod2wp TITLE: Blog post title
 
 =for pod2wp CATEGORY: cat1, cat2
 
 =for pod2wp TAGS: tag1,tag2,tag3
 
 =head1 Some header
 
 Text of your post ...
 ...

then:

 % pod2wp post1.pod

this will create a draft post. To publish directly:

 % pod2wp --publish post1.pod

Note that this will also modify your POD file and insert this paragraph at the top:

 =for pod2wp POSTID: 1234

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:

 % pod2wp post1.pod

You can use --publish to publish the post, or --no-publish to revert it to draft.

To set more attributes:

 % pod2wp post1.pod --comment-status open \
     --extra-attr ping_status=closed --extra-attr sticky=1

Another example, to schedule a post in the future:

 % pod2wp post1.pod --schedule 20301225T00:00:00

OPTIONS

* marks required options.

Main options

--comment-status=s

Whether to allow comments (open) or not (closed).

Default value:

 "closed"

Valid values:

 ["open","closed"]
--extra-attr=s%

Set extra post attributes, e.g. ping_status, post_format, etc.

Each value is a name-value pair, use key=value syntax. Can be specified multiple times.

--extra-attrs-json=s

Set extra post attributes, e.g. ping_status, post_format, etc (JSON-encoded).

See --extra-attr.

--filename=s*, -f

Path to POD document to publish.

Can also be specified as the 1st command-line argument.

--publish

Whether to publish post or make it a draft.

Equivalent to `--extra-attr post_status=published`, while `--no-publish` is equivalent to `--extra-attr post_status=draft`.

--schedule=s

Schedule post to be published sometime in the future.

Equivalent to `--publish --extra-attr post_date=DATE`. Note that WordPress accepts date in the `YYYYMMDD"T"HH:MM:SS` format, but you specify this option in regular ISO8601 format. Also note that time is in your chosen local timezone setting.

Configuration options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--no-config, -C

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

 undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]
--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--dry-run, -n

Run in simulation mode (also via DRY_RUN=1).

--help, -h, -?

Display help message and exit.

--password=s*
--proxy=s*

Example: `https://YOURBLOGNAME.wordpress.com/xmlrpc.php`.

--username=s*
--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C pod2wp pod2wp

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete pod2wp 'p/*/`pod2wp`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/pod2wp.conf, ~/pod2wp.conf, or /etc/pod2wp.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

 comment_status (see --comment-status)
 extra_attrs (see --extra-attr)
 filename (see --filename)
 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)
 password (see --password)
 proxy (see --proxy)
 publish (see --publish)
 schedule (see --schedule)
 username (see --username)

ENVIRONMENT

POD2WP_OPT => str

Specify additional command-line options.

FILES

~/.config/pod2wp.conf

~/pod2wp.conf

/etc/pod2wp.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-pod2wp.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-pod2wp.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-pod2wp

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.

SEE ALSO

org2wp.

html2wp.

wp-xmlrpc.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2017, 2016 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.