- Quick start guide - A quick start guide to help new volunteers get the information they need.
- Information for volunteers - A guide to help volunteers familiarize themselves with the team’s workflow / tools.
- Information for authors - the process of submitting an article.
- MagPi MMS - how to use the MagPi MMS.
- MagPi GIT - how to use the MagPi GIT scripts.
- Layout & fonts - description of the standard layout and associated fonts.
- PDF creation - instructions for the generation of PDF for electronic and paper publication.
- 1 Article / idea submission
- 2 Submission formats
- 3 Style guide
- 4 General tips
- 5 Timescales & deadlines
Article / idea submission
We encourage people to submit their articles or ideas for the magazine to us, simply email the editor (firstname.lastname@example.org) details and we shall discuss if and when we can fit it in.
As the magazine's focus is the Raspberry Pi and the surrounding community of users, articles can be anything to do with the Raspberry Pi and it's use.
Articles submitted using text based formats are preferable to DOCX, PDF etc. Articles may also be submitted as an SLA file produced using the Raspbian (Debian Wheezy) version of Scribus.
If you wish to submit your article in Scribus format, please be sure to read the relevant information regarding Scribus installation, standard fonts and layouts on the following pages:
RPi, Pi or Raspberry Pi
All references to the Raspberry Pi within an article must use the full name rather than a shortened form such as RPi, R-Pi, Pi etc.
Numbers as text or figures
- All numbers within between 0 and 10 should be written in full form e.g. one, two three.
- Use digits for decimals, percentages, and when there are units.
- Numbers at the beginning of a sentence should always be written out.
- Do not mix digits and words — in this case, use digits.
GB, Gb, Mb, MB or Mbytes
Please be consistent in the use of acronyms for storage units:
- KB - Kilobyte
- MB - Megabyte
- GB - Gigabyte
- TB - Terrabyte
Storage unit acronyms should always be in upper case.
The following should only be used when discussing network access speed:
- Kb - Kilobit
- Mb - Megabit
Electrical symbols and notation
When including electrical quantities within an article or diagram, these should always be expressed using European notation where the use of a decimal point is avoided. This alleviates the problem that decimal separators tend to 'disappear' when printing or photocopying an article or diagram. Examples:
- 3V3 - 3.3 V
- 1V8 - 1.8 V
- 4k7 – a resistor value of 4.7 kΩ
- 8k2 – a resistor value of 8.2 kΩ
Articles using notation should include the following footnote:
Tip: Engineers often use ‘European notation’ such as 3V3 in electrical drawings / discussion to indicate 3.3V. This ensures the decimal point is clearly marked and 3.3V is not misread as 33V.
Articles within the magazine should follow the punctuation rules for British English, if a punctuation mark (. , ? !) belongs to a quote it should be placed inside the quotation marks:
"Bob," she said " was a lovely dog."
But if the punctuation mark belongs to the sentence put it outside:
They called him "The Hulk".
Here are a few points to remember:
- Keep it brief - A typical 2 Page article with images contains around 700 words, the text is purposely kept large (12pt FreeSans Font) to aid reading on various devices and print sizes. We aim to keep most articles within 2 page or less, if longer it can always be split into a series of articles.
- Remember beginners will read it - Where possible explain specific terminology and assume the reader is unfamiliar with your chosen topic. Also remember that people will have different setups, so consider testing your instructions on a clean image (if applicable) and consider differences such as Rev1 and Rev2 boards.
- Make use of the Template - If you are able to, consider using the Scribus Template, this forms the basis of all the articles we produce in the magazine. Variations on the format are fine, but it is a good starting point to obtain what we expect. See section below for details.
- Provide Graphics and Images - Where possible obtain suitable graphics and images. Note all images, photos and graphics MUST be free for commercial use (please flag to us beforehand any items you are unsure about).
- Work with us - Keep in contact and let us know if you are writing something specific, the content of the next issue is usually allocated quickly so it is helpful to know in advance the topic area and estimates of how long it will take you to produce the article. Make sure you keep us updated if it is targeted for a specific issue. Often an early draft can help give us a headstart with graphics, layout, proofreading and feedback, so that the article is ready in time.
- Don't panic! - It is common not to know where to start when writing an article, my advice is to start with writing out what you aim to achieve in the article and why are you writing it (this may not end up in the final article, but it helps focus what you are doing).
- Out of Ideas? - Working on the magazine, we all have 1000s of ideas for articles, but very little time to produce them, so if you want to write but not sure what about, then we can probably give you some ideas (simply let us know what topics you are interested in!).
- Stuck on something? - Chances are we may be able to help, or do some testing if required.
- Need graphics? - The team can help source and produce graphics if you are unable to obtain suitable ones.
- Unsure about layouts? - The article will go through the layout team before publishing, so have a go and if you aren't happy ensure we have enough time to let the layout team work on it.
- Enjoy it! - Try to pick something you are passionate about sharing with the world. It is an amazing feeling when you see your article published at the end of the month.
Timescales & deadlines
While we currently do not have a fixed deadline for articles it is worth remembering the stages we go through:
Day 1-2 - The magazine content is agreed upon by the team.
Articles submitted or suggested after this point are likely to be put in following issues. Usually we have the outline of the content (and then order) worked out in the first few days of the month. We also review how the team got on in the previous month and what we can improve next month.
Completion Action: Bare-bones version of the magazine is put on Issuu with article place-holders.
Week 1 - Prepare articles
Authors contacted to ensure articles will be ready. Work with authors to ensure content is in suitable format for use, including graphics and layout (please submit early if help is needed - do not under-estimate how long it takes to prepare graphics and layout).
Completion Action: Everyone has a good idea of what they need to do and when.
Week 2 - Article drafts received, layout & testing started
We aim to start uploading completed/draft articles on to Issuu by this week. Additional work may be required with layout and graphics but full content is required. The status of the planned articles will be reviewed and replacements considered if content is not likely to be ready in time/testing shows issues.
Completion Action: Draft articles should appear on the Issuu Live Draft
Week 3 - All articles posted for proofreading
By this stage we should have all the articles in the draft of the magazine live on Issuu.
Completion Action: Completed articles should appear on the Issuu Live Draft
Week 4 - Final proof and checking
All input from the authors should now be finished, any changes which impact layout etc probably won't be accepted. All eyes are on the articles and everyone is encouraged to highlight any errors, typos, problems with the articles as quickly as possible so that we can fix them.
Completion Action: The Issuu Live Draft updated frequently with proof-reading feedback
Last day of the month - Magazine is completed
The magazine is released either that night or the following day. Then we start all over!
Completion Action: Release and look through what has been managed in a month!