—#!perl
# Note: This script is a CLI for Riap function /App/html2wp/html2wp
# and generated automatically using Perinci::CmdLine::Gen version 0.496
our
$AUTHORITY
=
'cpan:PERLANCAR'
;
# AUTHORITY
our
$DATE
=
'2020-05-01'
;
# DATE
our
$DIST
=
'App-html2wp'
;
# DIST
our
$VERSION
=
'0.004'
;
# VERSION
use
5.010001;
use
strict;
use
warnings;
use
Log::ger;
my
$cmdline
= Perinci::CmdLine::Any->new(
url
=>
"/App/html2wp/html2wp"
,
program_name
=>
"html2wp"
,
log
=> 1,
);
$cmdline
->run;
# ABSTRACT: Publish HTML document to WordPress as blog post
# PODNAME: html2wp
__END__
=pod
=encoding UTF-8
=head1 NAME
html2wp - Publish HTML document to WordPress as blog post
=head1 VERSION
This document describes version 0.004 of html2wp (from Perl distribution App-html2wp), released on 2020-05-01.
=head1 SYNOPSIS
Usage:
% html2wp [--comment-status=s] [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--dry-run] [--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] <filename>
=head1 DESCRIPTION
To use this program, first create C<~/html2wp.conf> containing the API
credentials, e.g.:
username=YOURUSERNAME
password=YOURPASSWORD
You can also put multiple credentials in the configuration file using profile
sections, e.g.:
[profile=blog1]
username=YOURUSERNAME
password=YOURPASSWORD
[profile=blog2]
username=YOURUSERNAME
password=YOURPASSWORD
and specify which profile you want using command-line option e.g.
C<--config-profile blog1>.
then:
% html2wp post1.html
(You should provide blog post title in your HTML in the C<< E<lt>titleE<gt> >> or C<< E<lt>meta
name="title" content="..."E<gt> >>. You can also put categories in C<< E<lt>meta
name="categories" content="cat1,cat2,..."E<gt> >> and tags in C<< E<lt>meta name="tags"
content="tag1,tag2,..."E<gt> >>.)
The above command will create a draft post. To publish directly:
% html2wp post1.html ... --publish
Note that this will also modify your HTML file and insert this element at the
beginning of the document:
<meta name="postid" content="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:
% html2wp post1.html
You can use C<--publish> to publish the post, or C<--no-publish> to revert it to
draft.
To set more attributes:
% html2wp post1.html ... --comment-status open \ --extra-attr
ping_status=closed --extra-attr sticky=1
Another example, to schedule a post in the future:
% html2wp post1.html --schedule 20301225T00:00:00
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--comment-status>=I<s>
Whether to allow comments (open) or not (closed).
Default value:
"closed"
Valid values:
["open","closed"]
=item B<--extra-attr>=I<s>%
Set extra post attributes, e.g. ping_status, post_format, etc.
Each value is a name-value pair, use I<key=value> syntax. Can be specified multiple times.
=item B<--extra-attrs-json>=I<s>
Set extra post attributes, e.g. ping_status, post_format, etc (JSON-encoded).
See C<--extra-attr>.
=item B<--filename>=I<s>*, B<-f>
Path to HTML document to publish.
=item B<--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`.
=item B<--schedule>=I<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.
=back
=head2 Configuration options
=over
=item B<--config-path>=I<s>, B<-c>
Set path to configuration file.
=item B<--config-profile>=I<s>, B<-P>
Set configuration profile to use.
=item B<--no-config>, B<-C>
Do not use any configuration file.
=back
=head2 Environment options
=over
=item B<--no-env>
Do not read environment for default options.
=back
=head2 Logging options
=over
=item B<--debug>
Shortcut for --log-level=debug.
=item B<--log-level>=I<s>
Set log level.
=item B<--quiet>
Shortcut for --log-level=error.
=item B<--trace>
Shortcut for --log-level=trace.
=item B<--verbose>
Shortcut for --log-level=info.
=back
=head2 Output options
=over
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
undef
=item B<--json>
Set output format to json.
=item B<--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]
=item B<--page-result>
Filter output through a pager.
=back
=head2 Other options
=over
=item B<--dry-run>
Run in simulation mode (also via DRY_RUN=1).
Default value:
""
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--password>=I<s>*
=item B<--proxy>=I<s>*
Example: `https://YOURBLOGNAME.wordpress.com/xmlrpc.php`.
=item B<--username>=I<s>*
=item B<--version>, B<-v>
Display program's version and exit.
=back
=head1 COMPLETION
This script has shell tab completion capability with support for several
shells.
=head2 bash
To activate bash completion for this script, put:
complete -C html2wp html2wp
in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
To activate tcsh completion for this script, put:
complete html2wp 'p/*/`html2wp`/'
in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).
=head2 other shells
For fish and zsh, install L<shcompgen> as described above.
=head1 CONFIGURATION FILE
This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/html2wp.conf>, F<~/html2wp.conf>, or F</etc/html2wp.conf>.
All found files will be read and merged.
To disable searching for configuration files, pass C<--no-config>.
You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.
You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program matches.
Finally, you can filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[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.
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)
=head1 ENVIRONMENT
=head2 HTML2WP_OPT => str
Specify additional command-line options.
=head1 FILES
F<~/.config/html2wp.conf>
F<~/html2wp.conf>
F</etc/html2wp.conf>
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-html2wp>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-html2wp>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-html2wp>
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.
=head1 SEE ALSO
L<org2wp>.
L<pod2wp>.
L<wp-xmlrpc>.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2020, 2017 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.
=cut