Submissions formatting guide

15 posts / 0 new
Last post
Mike Harman
Offline
Joined: 7-02-06
Feb 5 2008 23:45
Submissions formatting guide

Ret did this, starting a thread so we can work on it easily:

How to submit and format articles and images to the library, history and news sections of libcom

A well formatted article is easier and more pleasant to read and should be easier for site users to quickly print off a readable copy. So a little extra work is worth it.

Many articles submitted to the library have been scanned in from hard copies of varying quality; the lower the quality of the original source book or magazine the initial scan comes from, the more errors needing correction in the scanned text. So proofread the scanned text as necessary for mistakes to be corrected.

SUBMITTING AND FORMATTING

First, take a look at a formatted article - http://libcom.org/library/reds-green-short-tour-clerkenwell-radicalism. This will give you an idea of what we are talking about below. Also read the formatting guides for news and Library and History.

Submitting text/article
1) Click on 'create content' at top of page.
2) Click on library, history or news. This will take you to the appropriate page.
3) Type in the title of the article in the 1st box.
(Below the title box is the image box; it is usually preferable for an article to be accompanied by an image, but we will deal with this later, after the text has been entered.)
4) Choose the appropriate categories for the article in the 'regions' and 'sectors' list. (If you are unsure on the correct choice, admins can do this after submission when the article is sent into the moderation queue for checking.)
Also fill in, where appropriate, the 'authors, people and groups' and 'tags' boxes. catch - these are admin/editor only now
5) Enter a brief explanation of the article in the 'Introduction' box. If appropriate, this could be the 1st paragraph of the article. Otherwise, write a short descriptive summary of no more than a few lines. This will appear at the beginning of the article in bold type in the finished submission.
6) Paste in the article itself to the 'Body' box.

The various buttons above the 'Body' box are for formatting the article; to use them, first highlight the part of the text you want to format, then click the appropriate button.
For example; if you want to italicise some text, just highlight and click the 'italic' button. Do the same to make bold.
'Quote' works the same as it does in the forums; it will

Quote:
put text in a quote box

. Just highlight the quote and press the 'Quote' button.

Quote:
The Chinese anarchist movement
A history of the Chinese anarchist movement in France, Japan and China itself from 1900 up to the formation of the Chinese Communist Party.

If you do not use the break button, the break will be made automatically. When you do a final check of the formatting - by pressing the Preview button - before submitting the article, check that the break - - is made in an appropriate place place in the text.
'Image' will be explained below.
'Underline' is self-explanatory.
'Url' is for putting links in articles to other sites on the internet or to elsewhere on Libcom. An URL is a web address, such as; http://en.wikipedia.org/wiki/Uniform_Resource_Locator. This URL will take you to the wikipedia page about URLs. To do the link as a word (for example, 'see here'); paste in the link and then highlight it, click on the 'url' button and it should surround it like this;
[url=Enter URL here]see here[/url] (in this case 'see here' is the link). Then delete 'Enter URL here' in the 1st bracket and paste in the same place the appropriate URL. This will now appear in the text as see here.

Other formatting tips. - catch - this should probably just link to the bbcode guide
There are some ways of formatting for which there are no buttons. Instead of the buttons automatically writing the formatting code, you must type formatting code symbols (called BBcode) around the appropriate text. Text is enclosed within two brackets, with the 2nd bracket using a slash / to close the code command. See below for practical examples.
It often improves the look of an article if heading, sub-heading etc are centered. This is done by typing

at the start of the heading, and

at the end. This will appear like this;

The Communist Flying Saucers are Coming - A. Posadist

.
If you are are doing a lot of centering, then - rather than type

and

every time - speed things up and copy
onto your pasteboard and just paste it as necessary (remembering to add the / to front of the 2nd bracket).
Sometimes a piece of text may be italicised, bolded and centered;
[center]like this


In such a case, make sure that the sequence of the formatting code symbols mirror each other on both sides of the text;

A Heading

is correct.
While;
A Heading

is wrong.

Some articles in their original format have too many line breaks. to correct this use a site like this one; http://www.fwointl.com/FWOFormatter.html
- and set max characters to 999999 and Format.

Articles can also be improved by enlarging some headings, like this;

Revolutionary Knitwear and Its Praxis

To determine the size of the font, type (or whatever is your preferred number) and then close with

Footnotes
- these currently aren't available to anyone except editors and admins, we'll probably add a wikipedia style [ref:] thing as well so it's more like bbcode.

Various punctuations on your keyboard - the 'equal' = symbol, or asterisk *, for example - can also be used as ways of breaking up and defining different sections of of articles. They work best when they are centered, as described above. Like this;

========

Or this;

* * *

Or get ornamental and mix two together, e.g. 8 & =;

====8888====

Submitting images

When uploading images:

1. Use jpg or png files only.
2. Give the file a meaningful name.
3. Don't upload huge pix (over a mb). If you can only find a large version of a pic, pix resizers can be found online to use or download for free.
4. Don't use AP or similar files.

To submit a main image that will appear at the top of the article, use the 'Image' box.
You will need to have the image downloaded to your computer.
Click the 'browse' button to browse your PC to find where you have stored the image. A 'file upload' window will appear.
If, for example, you have the pic as a file on your PC's desktop, choose 'desktop' from the 'Look in' box at the top of the 'file upload' window.
Then find your pic among the files listed on your desktop; click on it to make its name appear in 'file name' box.
Then click 'Open' and the file will appear in the 'Image' box on the Libcom submissions page.
Then press 'Upload' to bring the image file from your PC onto the site and into the article.
Then you can add, if you want to, in the appropriate box, a caption for your image. This caption will appear when readers hover their mouse over the image.

To submit an image within the main text of the article, as http://libcom.org/library/the-grunwick-strike-a-sivanandanhere; you must use the 'Image' button above the 'Body' box.
Find a suitable image online, right click on the image and 'copy image location'.
Right click and paste the copied link for the image into the appropriate place in the text in the 'Body' box.
Highlight the link and press 'Image' button. The pic should now appear within the text. You may wish to add a caption beneath the pic.
ideally we want images uploaded as files - but I really need to sort out a better way of doing this

Finally...
When possible, always provide the source of the article and the date of publication.

Red Marriott's picture
Red Marriott
Offline
Joined: 7-05-06
Feb 5 2008 23:56

Some of the coding is not showing on there - it's blank where there there should be code examples,eg, for centering - I guess cos it's functioning as code? But I wanted to show correct/incorrect coding.

Mike Harman
Offline
Joined: 7-02-06
Feb 6 2008 00:01

The code tags aren't working too great on it (that's what they're supposed to do, by the way). Will have to try to work that out.

I changed a couple of things:

tags/authors are editor/admin only now because we had so many useless tags in the database (some of those were admin created of course but we only have ourselves to blame now).

quote doesn't show ="username" outside forums anymore.

Probably the non-toolbar stuff should link to the overall bbcode guide. Also we should really kill the underline button.

Added a couple of other notes as well in the text.

Steven.'s picture
Steven.
Offline
Joined: 27-06-06
Feb 16 2008 19:09

this is ace. one small thing - the look of the site generally is based on left-aligning, i think it'd be preferable if all headings and things were left-aligned rather than centred. that be cool?

Red Marriott's picture
Red Marriott
Offline
Joined: 7-05-06
Feb 20 2008 22:10
Quote:
this is ace. one small thing - the look of the site generally is based on left-aligning, i think it'd be preferable if all headings and things were left-aligned rather than centred. that be cool?

I think that at least the main heading/title looks best centred. And for dividing article sections it looks better to have some things centred, also for print copies. All left aligned reminds me of people who couldn't use a typewriter properly or of the old teleprinters. Btw, is anyone more tech-savvy than me gonna finish this guide soonish?

Mike Harman
Offline
Joined: 7-02-06
Feb 20 2008 22:21

Ideally, we don't have anything aligned in the articles themselves (which will mean left visually at least to start with), and handle everything in the theme (which can be different for screen and print layout etc.). I'm not sure how far we can get with that using BBCODE though (which is why I've not got far finishing this up). The less layout in the theme, the easier it is to change stuff like that at a later date without any pain.

Mike Harman
Offline
Joined: 7-02-06
Feb 21 2008 10:46

Just had to change some input format stuff around.

We should emphasise that people have to put full line breaks between paragraphs.

Also people should use <blockquote></blockquote> instead of quote tags outside the forums wherever possible.

Mike Harman
Offline
Joined: 7-02-06
Apr 5 2008 13:06

OK here's some general thoughts on this - I've split sections up and changed odd bits. Sorry it's taken so long to get to this I'm having a lot of trouble making things like bbcode and footnotes work together and stuff like that - so if we do this, we need to make sure we're telling people how to use them correctly - and at the moment I'm not 100% sure there's a correct way that won't cause problems down the line...

Quote:
How to submit and format articles and images to the library, history and news sections of libcom

A well formatted article is easier and more pleasant to read and should be easier for site users to quickly print off a readable copy. So a little extra work is worth it.

Many articles submitted to the library have been scanned in from hard copies of varying quality; the lower the quality of the original source book or magazine the initial scan comes from, the more errors needing correction in the scanned text. So proofread the scanned text as necessary for mistakes to be corrected.

SUBMITTING AND FORMATTING

First, take a look at a formatted article - http://libcom.org/library/reds-green-short-tour-clerkenwell-radicalism. This will give you an idea of what we are talking about below. Also read the formatting guides for news and Library and History.

Submitting text/article
1) Click on 'create content' at top of page.
2) Click on library, history or news. This will take you to the appropriate page.
3) Type in the title of the article in the 1st box. This should use normal sentence casing. I.e. "Strike continues at Ford". Rather than "Strike Continues at Ford".
4) Choose the appropriate categories for the article in the 'regions' and 'sectors' list. (If you are unsure on the correct choice, admins can do this after submission when the article is sent into the moderation queue for checking.)
5) Enter a brief explanation of the article in the 'Introduction' box. If appropriate, this could be the 1st paragraph of the article. Otherwise, write a short descriptive summary of no more than 2-3 sentences. This will appear at the beginning of the article in bold type in the finished submission.
6) Paste in the article itself to the 'Body' box.

This is good, added a note about titles. We should move the image box rather than tell people to ignore it and go back to it!

Quote:
The various buttons above the 'Body' box are for formatting the article; to use them, first highlight the part of the text you want to format, then click the appropriate button.
For example; if you want to italicise some text, just highlight and click the 'italic' button. Do the same to make bold.
For block quotes, you can use the 'quote' box, however you should ideally use <blockquote></blockquote> around this text since that will be formatted correctly.
Quote:
The Chinese anarchist movement
A history of the Chinese anarchist movement in France, Japan and China itself from 1900 up to the formation of the Chinese Communist Party.

'Image' will be explained below.

'Url' is for putting links in articles to other sites on the internet or to elsewhere on Libcom. An URL is a web address, such as; http://en.wikipedia.org/wiki/Uniform_Resource_Locator. This URL will take you to the wikipedia page about URLs. To do the link as a word (for example, 'see here'); paste in the link and then highlight it, click on the 'url' button and it should surround it like this;
<code> [url=Enter URL here]see here[/url]</code> (in this case 'see here' is the link). Then delete 'Enter URL here' in the 1st bracket and paste in the same place the appropriate URL. This will now appear in the text as see here.

This is good - we should probably split it into a separate "using bbcode FAQ" since it equally applies to the forums then link there, and keep the <blockquote></blockquote> note in the library. I took out underline because I want to kill that button (and the 'break' button). With the rest we should just link to the bbcode help I think.

Quote:
Some articles in their original format have too many line breaks. to correct this use a site like this one; http://www.fwointl.com/FWOFormatter.html
- and set max characters to 999999 and Format.

Yep! I want to reverse engineer that site and have a page on here for doing the same thing - maybe even a formatting button on the textarea itself.

Quote:
Articles can also be improved by enlarging some headings, like this;
[... snip ..]

OK we shouldn't do this - we should use <h2> <h3> <h4> tags instead.

Quote:
Footnotes
Footnotes can be automatically generated at the end of articles. Where you would normally put the footnote number like [1] instead, put the text of your footnote wrapped in <fn>Footnote goes here</fn> tags. When you submit the article, Drupal will find all the footnotes and format the superscript numbers and link to them for you.

Wrote this bit up, but I still want to get a bbcode style thing working for footnotes since the current method is a bit dodgy.

- these currently aren't available to anyone except editors and admins, we'll probably add a wikipedia style [ref:] thing as well so it's more like bbcode.

Quote:
Various punctuations on your keyboard - the 'equal' = symbol, or asterisk *, for example - can also be used as ways of breaking up and defining different sections of of articles. They work best when they are centered, as described above. Like this;
========

Or this;

* * *

Or get ornamental and mix two together, e.g. 8 & =;

====8888====

We should use <hr> here instead (creates a horizonal rule) - then we can theme everything consistently across the site. Similar thing to the <h3> tags.

Quote:
Submitting images

1. Use jpg or png files only.
2. Give the file a meaningful name.
3. Don't upload files over one MB. If you can only find a large version of a pic, various resizing applications can be found online, or download (http://gimp.org is a good one)
4. Do not use copyright images, and especially not copyright images from news agencies like AP.

Instructions for windows users:
To submit a main image that will appear at the top of the article, use the 'Image' box.
You will need to have the image downloaded to your computer.
Click the 'browse' button to browse your PC to find where you have stored the image. A 'file upload' window will appear.
Browse to the file on your computer, it will often be downloaded to the "Desktop" folder
Click 'Open' and the file will appear in the 'Image' box on the Libcom submissions page.
Then press 'Upload' to bring the image file from your PC onto the site and into the article.
Then you can add, if you want to, in the "title" field, a caption for your image. This caption will appear when readers hover their mouse over the image.

This is good. I'm planning to add titles from that field under images at some point as well.

Quote:
To submit an image within the main text of the article, as http://libcom.org/library/the-grunwick-strike-a-sivanandanhere; you must use the 'Image' button above the 'Body' box.
Find a suitable image online, right click on the image and 'copy image location'.
Right click and paste the copied link for the image into the appropriate place in the text in the 'Body' box.
Highlight the link and press 'Image' button. The pic should now appear within the text. You may wish to add a caption beneath the pic.

We need to fix how this works - the best way is to upload files as attachments to the article, then use them from there. However that's really messy. I want to leave this out until we have a decent way to do it.

Quote:
Finally...
When possible, always provide the source of the article and the date of publication.

Yep. I'll post all this as a draft below.

Mike Harman
Offline
Joined: 7-02-06
Apr 5 2008 13:25

OK here's a try at it. I mainly took stuff out that I'm not sure about, most of which is stuff we don't have a 'right' way to do yet. Sorry Ret. I think our best bet is to get this up with stuff that's definitely fine, and it's been really useful for identifying a few things that need fixing semi-urgently - then we can document them when that's done.

OK here's some general thoughts on this - I've split sections up and changed odd bits. Sorry it's taken so long to get to this I'm having a lot of trouble making things like bbcode and footnotes work together and stuff like that - so if we do this, we need to make sure we're telling people how to use them correctly - and at the moment I'm not 100% sure there's a correct way that won't cause problems down the line...

How to submit and format articles and images to the library, history and news sections of libcom

A well formatted article is easier and more pleasant to read and should be easier for site users to quickly print off a readable copy. So a little extra work is worth it.

Many articles submitted to the library have been scanned in from hard copies of varying quality; the lower the quality of the original source book or magazine the initial scan comes from, the more errors needing correction in the scanned text. So proofread the scanned text as necessary for mistakes to be corrected.

Submitting and formatting

First, take a look at a formatted article - http://libcom.org/library/reds-green-short-tour-clerkenwell-radicalism. This will give you an idea of what we are talking about below. Also read the formatting guides for news and Library and History.

Submitting text/article
1) Click on 'create content' at top of page.
2) Click on library, history or news. This will take you to the appropriate page.
3) Type in the title of the article in the 1st box. This should use normal sentence case. I.e. "Strike continues at Ford". Rather than "Strike Continues at Ford".
4) Choose the appropriate categories for the article in the 'regions' and 'sectors' list. (If you are unsure on the correct choice, it can be done by an editor after submission.)
5) Enter a brief explanation of the article in the 'Introduction' box. If appropriate, this could be the 1st paragraph of the article. Otherwise, write a short descriptive summary of no more than 2-3 sentences. This will appear at the beginning of the article in bold type in the finished submission.
6) Paste in the article itself to the 'Body' box.

For example:

Title:
The Chinese anarchist movement
Introduction:
A history of the Chinese anarchist movement in France, Japan and China itself from 1900 up to the formation of the Chinese Communist Party.

For formatting text in articles, please see our BBCODE and HTML FAQ.

Some articles in their original format have too many line breaks. to correct this use a site like this one; http://www.fwointl.com/FWOFormatter.html
- and set max characters to 999999 and Format.

Also ensure that you use (two) full line breaks for paragraphs to ensure readable text. One line break will not get caught by our automatic paragraph formatting.

Footnotes
Footnotes can be automatically generated at the end of articles. Where you would normally put the footnote number like [1] instead, put the text of your footnote wrapped in <fn>Footnote goes here</fn> tags. When you submit the article, Drupal will find all the footnotes and format the superscript numbers and link to them for you.

Submitting images
1. Use jpg or png files only.
2. Give the file a meaningful name.
3. Don't upload files over one MB. If you can only find a large version of a pic, various resizing applications can be found online, or download (http://gimp.org is a good one)
4. Do not use copyright images, and especially not copyright images from news agencies like AP.

Instructions for windows users:
To submit a main image that will appear at the top of the article, use the 'Image' box.
You will need to have the image stored locally on your computer.
Click the 'browse' button to browse your PC to find where you have stored the image. A 'file upload' window will appear.
Browse to the file on your computer, images downloaded from the internet usually default to your "Desktop" folder
Click 'Open' and the file will appear in the 'Image' field on the Libcom submissions page.
Then press 'Upload' to bring the image file from your PC onto the site and into the article.
Then you can add, if you want to, in the "title" field, a caption for your image. This caption will appear when readers hover their mouse over the image.

Finally...
When possible, always provide the source of the article and the date of publication.

--

OK how's that look?

Red Marriott's picture
Red Marriott
Offline
Joined: 7-05-06
Apr 5 2008 14:31

Good,catch - but it needs a reminder to put full line breaks for paras; and when I last tried, I couldn't put italics etc in footnotes. Also needs a link to BBCODE and HTML FAQ. And will future changes mess up earlier formatting in the library? Considering the number of texts in library now, an important question. Also, the article i linked to as an example of formatting uses centering of headings, which is info you've cut out.

Mike Harman
Offline
Joined: 7-02-06
Apr 5 2008 15:07
Ret Marut wrote:
Good,catch - but it needs a reminder to put full line breaks for paras;

Added.

Quote:
and when I last tried, I couldn't put italics etc in footnotes.

Yeah this is one of the many things which is broken at the moment.

Quote:
Also needs a link to BBCODE and HTML FAQ

Yep. I want to make that very short basic page, with some links to common web resources at the end.

Quote:
. And will future changes mess up earlier formatting in the library?

If stuff is formatted with valid html (which correct bbcode usage ought to do), they shouldn't, no.

Quote:
Also, the article i linked to as an example of formatting uses centering of headings, which is info you've cut out.

Yeah I know. We should definitely use <h> tags (Which think have a bbcode equivalent) for headings - then centering, or not centering can be done in the theme. BBCODE stuff will still work.

Let's see how raw bbcode headers look:

header 1

header 2

header 3

header 6
Mike Harman
Offline
Joined: 7-02-06
Apr 5 2008 15:08

Hmm, could do with some improvement that smile

Red Marriott's picture
Red Marriott
Offline
Joined: 7-05-06
Apr 5 2008 15:40

Looks like an eye test eek

Mike Harman
Offline
Joined: 7-02-06
Apr 10 2008 12:02

I've posted what we've got up here: http://libcom.org/library/notes/content-guidelines/howto-article-submissions

Any obvious errors feel free to edit, and we can add stuff here or directly to it as we go along. Thanks!

Steven.'s picture
Steven.
Offline
Joined: 27-06-06
Apr 12 2008 01:02

nice one guys!