Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tbrowder/rakuadvent-wordpress

Aid for authors on WordPress, especially for the Raku Advent website
https://github.com/tbrowder/rakuadvent-wordpress

Last synced: 23 days ago
JSON representation

Aid for authors on WordPress, especially for the Raku Advent website

Host: GitHub
URL: https://github.com/tbrowder/rakuadvent-wordpress
Owner: tbrowder
License: artistic-2.0
Created: 2019-12-19T11:50:44.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2020-01-03T10:10:35.000Z (about 5 years ago)
Last Synced: 2024-12-09T19:50:19.738Z (about 1 month ago)
Language: HTML
Size: 48.8 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

[![Build Status](https://travis-ci.org/tbrowder/RakuAdvent-WordPress.svg?branch=master)](https://travis-ci.org/tbrowder/RakuAdvent-WordPress)

# RakuAdvent::WordPress

This module provides a Raku tool (*make-wp-input*) to aid Raku Advent
authors in preparing their article source for conversion to a format
compatible with the html and css used by WordPress (WP).

## Installation
```raku
zef install RakuAdvent::WordPress;
```
## Documentation
```raku
zef install p6doc
p6doc RakuAdvent::WordPress;
```
## Example uses

Basic usage:
```raku
$ make-wp-input -eg > advent.html
Usage: make-wp-input [-x][-c][-eg][-debug][-help]
```

Long help:
```raku
$ make-wp-input -help
Usage: make-wp-input [-x][-c][-eg][-debug][-help]
Converts html source in the input file
to WordPress html in the output file 'wordpress.html'.

Use the '-x' option to extract headings from the input
file for QC.

Use the '-eg' option to write the example file to STDOUT.

Use the '-c' option to convert to markdown. [NOT YET IMPLEMENTED]
```

See the example html source file included with
the module:
```raku
$ make-wp-input -eg > advent.html
```

Create a raw html source file and format it
for input to WordPress (with automatic error checking):
```raku
$ make-wp-input advent.html
Normal end.
See output files:
'wordpress.html'
'.wordpress.html.tmp.no-inserted-code'
```

Note the file 'wordpress.html' is the one that contains
your source converted for use as your WordPress article.
It includes any code you have inserted into it. The
second file, the hidden file '.wordpress.html.tmp.no-inserted-code',
is for use during the conversion to markdown (which is
not yet implemented) but it hasn't had the code insertions
completed. That is because the insertions into a markdown
file will require slightly different handling.

Sometimes in a tangle of html in a long
article it's easy to lose track of the
sequence and size of headings, so we have
a check for that:
```raku
$ make-wp-input advent.html -x

Introduction

Background

Article creation

Summary

APPENDIX

Notes

References

```

Note the source html must meet some simple rules
to ensure success with the current state of *make-wp-input*:

1. The following opening tags should be the only characters on their respective
lines:

- \

2. At the moment do **not** use any html comments except:

- \ [ON THE FIRST LINE ONLY]
- \

See the example file for an illustration of the title line. See the
test file `t/02-example-advent-html.t` for an example of inserting
code into the source file.

Note the interaction of other html source tags with WP may not be as
expected. You are encouraged to preview results and experiment for
yourself. The WP website is still under development, and user input is
encouraged.

## Planned features
- Convert html to Github-flavored markdown
- Allow paragraphs in the source html to be
recognized by either blank lines above and below
the text or a line with a closing tag on the
line before the text or an opening tag on
the line following the text
- Use the WordPress API to do all interaction
with the user via the command line including:
- posting the generated WP html
- setting the scheduled publication time
- changes to the post or scheduled time

## References
- WordPress API
- Github API

## See also
- `PasteBin::Gist`
- `Text::Wrap`
- `Acme::Advent::Highlighter`

## LICENSE

Artistic 2.0. See the license [here](./LICENSE).