view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    App::org2wp - Publish Org document (or heading) to WordPress as blog
    post

VERSION
    This document describes version 0.013 of App::org2wp (from Perl
    distribution App-org2wp), released on 2022-05-02.

FUNCTIONS
  org2wp
    Usage:

     org2wp(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Publish Org document (or heading) to WordPress as blog post.

    This is originally a quick hack because I couldn't make
    L<https://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.

    First, create "~/org2wp.conf" containing the API credentials, e.g.:

     ; use INI (IOD) format for this file
     proxy=https://YOURBLOGNAME.wordpress.com/xmlrpc.php
     username=YOURUSERNAME
     password=YOURPASSWORD

    Note that "proxy" is the endpoint URL of your WordPress instance's
    XML-RPC server, which can be hosted on "wordpress.com" or on other
    server, including your own. It has nothing to do with HTTP/HTTPS proxy;
    the term "proxy" is used by the XMLRPC::Lite and SOAP::Lite Perl
    libraries and "org2wp" simply uses the same terminology.

    You can also put multiple credentials in the configuration file using
    profile sections, e.g.:

     ; use INI (IOD) format for this file
     [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".

   Document mode
    You can use the whole Org document file as a blog post (document mode)
    or a single heading as a blog post (heading mode). The default is
    document mode. 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 ...
     ...

    then:

     % 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 setting
    line at the top:

     #+POSTID: 1234
     #+POSTTIME: [2020-09-16 Wed 11:51]

    where 1234 is the post ID retrieved from the server when creating the
    post, and post time will be set to the current local time.

    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:

README  view on Meta::CPAN

    the "PROPERTIES" drawer.

    If, for example, you specify "-l 2" instead of "-l 1" then the level-2
    headings will become blog posts.

    In heading mode, you can use several options to select only certain
    headlines which contain (or don't contain) specified tags.

   FAQ
   What if I want to set HTTP/HTTPS proxy?
    You can set the environment variable "HTTP_proxy" (and "HTTP_proxy_user"
    and "HTTP_proxy_pass" additionally). See the SOAP::Lite documentation
    for more details, which uses LWP::UserAgent underneath.

    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).

    *   exclude_heading_tags => *array[str]*

        Exclude heading that has any of the specified tag(s).

    *   extra_attrs => *hash*

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

    *   filename* => *filename*

        Path to Org document to publish.

    *   include_heading_tags => *array[str]*

        Only include heading that has all specified tag(s).

    *   password* => *str*

    *   post_heading_level => *posint*

        Specify which heading level to be regarded as an individula blog
        post.

        If specified, this will enable *heading mode* instead of the default
        *document mode*. In the document mode, the whole Org document file
        is regarded as a single blog post. In the *heading mode*, a heading
        of certain level will be regarded as a single blog post.

    *   post_password => *str*

        Set password for posts.

    *   proxy* => *str*

        Example: C<https://YOURBLOGNAME.wordpress.com/xmlrpc.php>.

        Note that "proxy" is the endpoint URL of your WordPress instance's
        XML-RPC server, which can be hosted on "wordpress.com" or on other
        server, including your own. It has nothing to do with HTTP/HTTPS
        proxy; the term "proxy" is used by the XMLRPC::Lite and SOAP::Lite
        Perl libraries and "org2wp" simply uses the same terminology.

    *   publish => *bool*

        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 => *date*

        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.

    *   username* => *str*

    Special arguments:

    *   -dry_run => *bool*

        Pass -dry_run=>1 to enable simulation mode.

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-org2wp>.

SOURCE
    Source repository is at <https://github.com/perlancar/perl-App-org2wp>.

AUTHOR
    perlancar <perlancar@cpan.org>

CONTRIBUTING
    To contribute, you can send patches by email/via RT, or send pull
    requests on GitHub.

    Most of the time, you don't need to build the distribution yourself. You
    can simply modify the code, then test via: