Diff for "KnowHow/FSFELife/EditorialGuidelines"

Differences between revisions 18 and 19
⇤ ← Revision 18 as of 2018-09-07 09:20:13 →
Size: 4504
Editor: alex.busch
Comment: Move editorial guide from web to wiki
← Revision 19 as of 2018-09-07 09:35:58 → ⇥
Size: 4035
Editor: alex.busch
Comment: Move editorial guidelines here from https://fsfe.org/contribute/editors/editorial-guidelines.en.html
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## page was copied from TechDocs/Mainpage/Slider
## page was renamed from TechDocs/Mainpage/updating_slider
Attention this page is under construction!

## page was copied from TechDocs/Mainpage/Editing		 /!\ Attention this page may be outdated!
Line 9: Line 5:
= General information on working with the FSFE website source = In editing and updating existing content for www.fsfe.org, it's best to follow certain standard practices in style, in order that both information pages and news content remain consistent and above all, clear. This guide is not designed to impact on individual creativity. By providing basic parameters this guide intends that the hard work is done before editing begins, and that contributors can be as thoughtful in their writing as they wish.
Line 11: Line 7:
/!\ Please, read the information on [[TechDocs/Mainpage/Editing|TechDocs/Mainpage/Editing]], it is necessary for getting access to web pages and coordinating your work with others. = Tone and Style =
Line 13: Line 9:
= Image Slider =  * Articles shouldn't feel like a sales pitch (even if what's being 'sold' is Free).
 * Articles should be informative: they should center on a concept and detail that concept, breaking it down in longer pieces, using subtitles.
 * Make sure that the articles are educated: it’s important that the writing sounds authoritative. If you use quotes, or refer to sources, link to them.
Line 15: Line 13:
This page will help you modify or update the image slider on our [[https://fsfe/org|front page]].
From time to time it is necessary to update the content shown on slides or change the order of existing slides.		 = Spelling and Grammar =
Line 18: Line 15:
Creating a new slide to appear on the Home page.  * Use preferably British English spelling, if you choose to do otherwise for some reason (e.g. interview, quote, etc.) stay consistent throughout the text.
 * Use complete sentences. Avoid beginning sentences with ‘however’, ‘because’, or ‘so’.
 * Numbers below 10 should be written in letters (one, two, three) but numbers above 10 must be in numbers ('167', not 'one hundred sixty seven')
 * Don’t use dashes. Instead utilise colons, and semi colons.
 * Almost always use abbreviated forms. For example: "it's" and not "it is"; "that's" and not "that is"; "they're" and not "they are".
 * Always use the definite article of "Free Software Foundation Europe", but never when using the acronym "FSFE". eg. "The Free Software Foundation Europe is 10 years old. FSFE has accomplished much...". Not "Free Software Foundation Europe is 10 years old. The FSFE has accomplished much..."
Line 20: Line 22:
== Image == = Formatting =
Line 22: Line 24:
'''1.''' First of all you will have to create/choose an image to be used as a background for the slide.
You will find all the pictures currently used for slider here: `~FSFE/fsfe-website/graphics/`.
After background image `new_image.jpg` is ready it has to be added there also. Please consider using JPEG format to make images lightweight.<<BR>>
<<BR>>
(!) Note: if you would like your slide to contain text, it is best to add it as a separate item, which will allow the slide to be adaptable to different screen resolutions (mobile phones, tablets, etc.)<<BR>>
<<BR>>
== Text ==		  * If the text is more than 500 words, break it up with sub-titles.
 * Use short paragraphs. As a rule, aim for paragraphs between 30 and 45 words.
 * The on-line marketing resource Copyblogger provides a very informative 10-step guide to copywriting. Of course, some of its points are sales orientated, but its general sentiment Is very useful indeed:
 * Do not use footnotes. This ensures greater portability of the article to different mediums and formats, and also makes for easier reading, if handled carefully.
 * Use the HTML abbr tag for acronyms and initialisms where appropriate. Note that this should not be used for the first instance of the use of the FSFE acronym, however.
 * Don't make any attempt to paginate documents that are intended for publication on-line in the first instance.
Line 30: Line 31:
'''2.''' Current slides are to be found in `~FSFE/fsfe-website/tools/frontpage`, they are numbered according to the order they appear in: `10_xxxx.en.xml`, `30_xxxx.en.xml`, etc.
By creating a new file like this, you can specify the text you want to appear on the slide and link it will lead to. Like this:		 = Terms =
Line 33: Line 33:
{{{
<?xml version="1.0" encoding="UTF-8"?>
<campaigns>
    <campaign running="yes" id="newslide">
        <text>this is a new text</text>
        <link>/campaigns/newnew</link>
    </campaign>
</campaigns>
}}}

== Style ==

'''3.''' To edit the style of the text, it's position on the page, other design issues and to add a link to the image created in step 1, please update `fsfe.less` file, located in

`~FSFE/fsfe-website/fsfe-website/look/`. Here is the part of that documents, describing PMPC slide:

{{{
        #boxpmpc {
            background: url('/graphics/pmpc_slider.jpg') left 33% no-repeat #666;
            background-size: cover;
            text-shadow: 0px 1px 8px rgb(0,0,0);

            .text, .text2 {
                .quote;
            }
            .text, .text2 {
                display: block;
                padding: 1.25em;
                min-width: 120px;
                font-size: 1.25em;
                hyphens: none;
                text-align: center;
            }
}}}

== Compile LESS into CSS ==

'''4.''' After changing the `fsfe.less`, you need to compile your modifications into css, the whole process is described on this [[https://fsfe.org/contribute/web/css.en.html|page]] and won't take long.

* First, you will have to install [[http://lesscss.org/|LESS]] if you haven't done so yet.

{{{
sudo apt-get install node-less

or

sudo apt-get install npm
sudo npm install -g less
}}}

* After that just follow the instructions given in the [[https://fsfe.org/contribute/web/css.en.html|guide]].

(!) Please, remember if you modify ''style.less'', you will need to compile all css.<<BR>>
<<BR>>

== Preview changes ==

'''5.''' If you decide to help with designing something for the website it's always best to check your modifications before publishing.<<BR>>

=== The test branch ===

The Git repository has two main code bases for the FSFE website, the ''master'', which is used to build the production instance of the website at [[https://fsfe.org|fsfe.org]], and the ''test'' branch, which is used to build [[https://test.fsfe.org/|test.fsfe.org]].

To work on major changes to the website, including debugging new features that could potentially break the site, you are encouraged to check out the ''test'' branch of the Git repository:

{{{
git checkout test
}}}

=== Building locally ===

You can build the fsfe.org website on your own computer to make previews of single pages possible offline and without having to wait for an online website build. The process of building the FSFE website locally is described here: [[https://wiki.fsfe.org/TechDocs/Mainpage/BuildLocally|/TechDocs/Mainpage/BuildLocally]]

Please be aware that it might take a while to build FSFE website locally.		  * When referring to the activities, views etc. of FSFE, the organisation's name (or its acronym) should be used. Avoid use of 'we' and 'us' in text for publication. Occasionally using such terms can be useful for greater impact in headlines and tag-lines. In these cases text should always be in quotes. Use of the third person maintains portability, clarity and professionalism.
 * 'Linux' is a kernel. GNU/Linux is an operating system. Use these terms accordingly in your writing to avoid confusion.
 * In the first instance of FSFE being referred to in an article, the organisation should be written thus: FSFE (Free Software Foundation Europe). Articles may be distributed beyond the FSFE website, or later copied by readers to other locations. FSFE is a term which connotes nothing without explanatory text of the meaning of the acronym.
 * Free Software should be referred to as Free Software. Not FOSS, FLOSS or OSS. Free Software and Open Source software is one and the same thing, approached from different points of view - they serve the same referential purpose (which is not to say that they communicate the same thing). Therefore compounded acronyms refer to the same thing twice in one term, which makes little sense, and encourages misunderstanding. We deal with Free Software, and thus we call it Free Software.

/!\ Attention this page may be outdated!

Contents

  1. Tone and Style
  2. Spelling and Grammar
  3. Formatting
  4. Terms

In editing and updating existing content for www.fsfe.org, it's best to follow certain standard practices in style, in order that both information pages and news content remain consistent and above all, clear. This guide is not designed to impact on individual creativity. By providing basic parameters this guide intends that the hard work is done before editing begins, and that contributors can be as thoughtful in their writing as they wish.

Tone and Style

  • Articles shouldn't feel like a sales pitch (even if what's being 'sold' is Free).
  • Articles should be informative: they should center on a concept and detail that concept, breaking it down in longer pieces, using subtitles.
  • Make sure that the articles are educated: it’s important that the writing sounds authoritative. If you use quotes, or refer to sources, link to them.

Spelling and Grammar

  • Use preferably British English spelling, if you choose to do otherwise for some reason (e.g. interview, quote, etc.) stay consistent throughout the text.
  • Use complete sentences. Avoid beginning sentences with ‘however’, ‘because’, or ‘so’.
  • Numbers below 10 should be written in letters (one, two, three) but numbers above 10 must be in numbers ('167', not 'one hundred sixty seven')
  • Don’t use dashes. Instead utilise colons, and semi colons.
  • Almost always use abbreviated forms. For example: "it's" and not "it is"; "that's" and not "that is"; "they're" and not "they are".
  • Always use the definite article of "Free Software Foundation Europe", but never when using the acronym "FSFE". eg. "The Free Software Foundation Europe is 10 years old. FSFE has accomplished much...". Not "Free Software Foundation Europe is 10 years old. The FSFE has accomplished much..."

Formatting

  • If the text is more than 500 words, break it up with sub-titles.
  • Use short paragraphs. As a rule, aim for paragraphs between 30 and 45 words.
  • The on-line marketing resource Copyblogger provides a very informative 10-step guide to copywriting. Of course, some of its points are sales orientated, but its general sentiment Is very useful indeed:
  • Do not use footnotes. This ensures greater portability of the article to different mediums and formats, and also makes for easier reading, if handled carefully.
  • Use the HTML abbr tag for acronyms and initialisms where appropriate. Note that this should not be used for the first instance of the use of the FSFE acronym, however.
  • Don't make any attempt to paginate documents that are intended for publication on-line in the first instance.

Terms

  • When referring to the activities, views etc. of FSFE, the organisation's name (or its acronym) should be used. Avoid use of 'we' and 'us' in text for publication. Occasionally using such terms can be useful for greater impact in headlines and tag-lines. In these cases text should always be in quotes. Use of the third person maintains portability, clarity and professionalism.
  • 'Linux' is a kernel. GNU/Linux is an operating system. Use these terms accordingly in your writing to avoid confusion.
  • In the first instance of FSFE being referred to in an article, the organisation should be written thus: FSFE (Free Software Foundation Europe). Articles may be distributed beyond the FSFE website, or later copied by readers to other locations. FSFE is a term which connotes nothing without explanatory text of the meaning of the acronym.
  • Free Software should be referred to as Free Software. Not FOSS, FLOSS or OSS. Free Software and Open Source software is one and the same thing, approached from different points of view - they serve the same referential purpose (which is not to say that they communicate the same thing). Therefore compounded acronyms refer to the same thing twice in one term, which makes little sense, and encourages misunderstanding. We deal with Free Software, and thus we call it Free Software.

KnowHow/FSFELife/EditorialGuidelines (last edited 2018-09-10 08:52:38 by alex.busch)