diff --git a/article-processor.md b/article-processor.md new file mode 100644 index 0000000..8d68d1e --- /dev/null +++ b/article-processor.md @@ -0,0 +1,255 @@ +--- +title: Article Processor +description: Generate a file to upload to this site, using article metadata. +--- + + +### Prerequisites + +Before you begin, ensure you have, as a minimum: +* a headline, +* the name(s) of the author(s), +* a header image, which will be shown behind the headline (so the content of this image can't be vital, like a graph), +* a caption for your header image, +* the copyright attribution for your header image, +* a brief description (one or two short sentences) of your article, and +* your article content. + +
+ +### Instructions + +Fill in the fields below, and then click the *download* button to generate a file to be uploaded to Reading School's BBC Young Reporter website. + +Give the authors' names in the format `First_Name Last_Initial`, and separate multiple authors with a comma - e.g. `John D, Emma S`. + +* If there are any headings inside your article, please place `# ` in front of them. +* For subtitles, use `## `, as so on for smaller headings, up to and including `###### `. +* For bullet points, use `* `, and for indented bullets, increase the indent using the tab button on your keyboard. +* For numbered lists, use the numbers/letters: e.g. `1. `. + +Note the requirement for spaces after each of the above items - for example: + +
### My Heading
+
+1. Numbered item
+    * Indented bulleted item
+ +will produce: + +
+

My Heading

+ +
    +
  1. Numbered item
    2. + +
+ +
+ +Other formatting can be done with the following: + +* For italics, use `*my italic text*`. +* For bold, use `**my bold text**`. +* For bold and italics, use `***my bold, italic text***`. +* For links, use `[text to show in article](URL)`. +* To include an extra image (besides the cover image), use: +
+
+
{% raw %}{% include image.html caption="IMAGE_CAPTION" copyright="IMAGE_COPYRIGHT" %}{% endraw %}
+

Replace `IMAGE_CAPTION` with a caption for the image, and `IMAGE COPYRIGHT` with the copyright owner. E.g.:

+
{% raw %}{% include image.html caption="Test image caption" copyright="Reading School" %}{% endraw %}
+
+
+ +* To include a video, upload it to YouTube and then use: +
+
+
{% raw %}{% include video.html id="VIDEO_ID" %}{% endraw %}
+

Replace `VIDEO_ID` with the YouTube video ID (e.g. for https://www.youtube.com/watch?v=dQw4w9WgXcQ, the video ID is dQw4w9WgXcQ). An example:

+
{% raw %}{% include video.html id="dQw4w9WgXcQ" %}{% endraw %}
+
+
+ + +The cover image for your article must be a JPEG image, and have the `jpg` file extension. If your image is a PNG, you can [convert it using an online tool](https://png2jpg.com/). The file name must also be the same as your article's file name. This will be provided to you when you download the file from this page. E.g. if the file you download from this page is `news-article.md` then your cover image must be `news-article.jpg` (capital letters **DO** matter). + +Any extra images for your article must be in the format: `ARTICLE_FILE_NAME--extra-IMAGE_ID.jpg`, where you replace `ARTICLE_FILE_NAME` with the file name you used for the cover image, and `IMAGE_ID` with a unique ID for the image - start at 1 for the first image in your article (excluding the cover image). E.g.: `news-article--extra-1.jpg`. + +
+ +### Example + +
# Headline
+
+## Heading2
+
+### Heading3
+
+#### Heading4
+
+##### Heading5
+
+###### Heading6
+
+Some text.
+
+1. Numbered item 1
+2. **Numbered item 2**
+* *Bullet 1*
+* Bullet 2
+    1. Numbered item 3
+
+***Bold & italics***
+
+A link to [Google](https://google.com).
+ +Will produce: + +
+

Headline

+ +

Heading2

+ +

Heading3

+ +

Heading4

+ +
Heading5
+ +
Heading6
+ +

Some text.

+ +
    +
  1. Numbered item 1
    2. +
  2. Numbered item 2
    3. +
+ + +

Bold & italics

+ +A link to Google. +
+ +
+ +### Generator + +
+
+
+ +
+
+ +
+
+ +
+
+ +
+ +
+ +
+
+ +
+ +
+ +
+
+
+ + + + \ No newline at end of file