Skip to content

Commit

Permalink
images for contribute section, rough update for translator instructio…
Browse files Browse the repository at this point in the history
…ns and style guide. hotosm/learnosm#82 refers. hotosm/learnosm#526 also refers. hotosm/learnosm#329 refers
  • Loading branch information
Nick-Tallguy committed Jun 18, 2017
1 parent faacfa7 commit 346938b
Show file tree
Hide file tree
Showing 6 changed files with 245 additions and 1 deletion.
62 changes: 61 additions & 1 deletion _posts/0150-09-20-translator.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,64 @@ When the instructions are updated & on this site in an agreed position then;
2. Delete the guide on the staging site wiki, but add a link there to these instructions in case someone has bookmarked it.


[Github 2]: /images/contribute/translate-image-upload.png
# Translator instructions - Transifex

You are viewing these instructions on a 'staging site', but the information is transferred frequently between this site and the main LearnOSM site. The [current staging site can be viewed here](http://nick-tallguy.github.io/en/). By using this staging site as an interim, we can check that we haven't lost any formatting marks in the translation process. Don't worry about losing the formatting - we'll put it back in afterwards, as long as we can work out where it goes.

LearnOSM has been using Transifex for a while, but we're still learning! Feedback is appreciated. At present we're not sure how many formatting marks will actually appear in the file that you view, or in the file which we download at the end of the process, so this guide is written on a very provisional basis.

There are limitations on how many languages we can actually display on LearnOSM. Please check if there is a generic version of your language before requesting another language. Although Transifex can cope with the variations on Spanish & English, LearnOSM cannot - please can you see if the main language 'will do'. Get in touch if there is a real problem and we'll try to sort something out.

## Priorities

We are carrying out a review of any guide before uploading it to Transifex, and you will see the date of that review at the head of the file. Some of these guides may already have been translated, but we can only offer the guide for translation from the latest version, which will be the one with the review date. It may be that only the context has altered where some guides have moved to different sections of LearnOSM. As there is no way for us to indicate that a particular module does not need translating in a particular language, you may wish to compare the modules against what is already on [LearnOSM](http://nick-tallguy.github.io/en/), in case it has already been translated. In a perfect world we would like each module translated, and another person to verify the translation - this is possible with the Transifex system, but only if enough people provide translations!



### essential-setup.txt
This is the file that contains all of the strings we need to use to make a language appear on the site, and to label all of the buttons. It's the first file we will need translating. Many of the strings appear on the Home page of the language you are translating, other strings will be used by the maintenance volunteers when they are adding downloadable versions of the guides, and also to add links to available sections.

### The priorities column
When you view the list of 'resources' for translation you should see a timer icon at the far right of the list. We can alter the priority of a guide using this timer. At present the only 'resource' which has a priority set is the **essential-setup.txt** resource which we need for ongoing maintenance. If / when there is an ongoing **Activation** because of a disaster, other guides may be labelled as more urgent.

### beginners section
For anyone new to Hot, the beginners section will give them some understanding of the system, and how to carryout basic editing.

### JOSM
Considered by many to be the editor needed if a 'mapper' is to progress beyond the beginner stage.

### Coordination
This section is being completely reviewed during 2015, & sections will only appear for translation when we are satisfied they are anticipated to be 'stable'.

### Other Chapters
If you have an interest in a particular subject, or role within an organisation, you may wish to translate something from elsewhere on the site. If we've reviewed it, and the images associated with the site, it will be available for translation. If there is something you wish to see translated, but it is not available at present, please let us know and we will prioritize it. email to [email protected] is the easiest route.
## What to translate
### From this header,
`---`
`layout: doc`
`title: iD Editor`
`permalink: /en/beginner/id-editor/`
`lang: en`
`category: beginner`
`---`
only the title **iD Editor** requires translation.

### From the main body
Please only change the words in the text - the formatting marks should be left in place
`The iD Editor`
`=============`

`> This guide may be downloaded as [beginner_id-editor_en.odt](/files/beginner_id-editor_en.odt) or [beginner_id-editor_en.pdf](/files/beginner_id-editor_en.pdf) `

In the extract above, you should ignore
`[beginner_id-editor_en.odt](/files/beginner_id-editor_en.odt)`
and
`[beginner_id-editor_en.pdf](/files/beginner_id-editor_en.pdf)`

This link should also be ignored
`![image1][]`
as should the file link which relates to it, which will probably be at the foot of the page.
`[image1]: /images/beginner/id-editor_image1.png`

The spaces at the beginning of lines of text are formatting instructions that the text and images should be indented. There are often two spaces at the end of a line of text, which is also a formatting instruction, as is `>` if it is at the beginning of a line.

184 changes: 184 additions & 0 deletions _posts/0150-10-20-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,187 @@ nosearch: true
---

## Documentation Style Guide

Paste of data from hackpad mentioned in https://github.com/hotosm/learnosm/issues/82

Style Guidelines
=========================

This document provides a set of general guidelines for developing and editing new
sections. The goal is to ensure sections are clear, consistent, and easy to read.

Note: This guide is for the EN version and is not necessarily applicable to
other languages. Initial guidelines were based on Geoserver's Style Guide.

Content conventions
--------------------

### Be concise

Sections should be concise and not just a brain dump. Reference material
should contain short pages and be easy to refer to without having to scroll
through a large volume of text.

### Avoid marketing

If the point of the document is to showcase a new feature it does not belong
in the documentation. Write an article or a blog post about it. If it is necessary
to point out a technical benefit of a feature then do so from a technical standpoint.

Bad
Super-overlays are a great way to publish super cool datasets awesomely in Google Earth!
Good
Super-overlays allow you to efficiently publish data via Google Earth.

### Be professional

Avoid the use of slang or other “colorful” language. The aim is to be informative,
not to keep the reader amused. Avoiding slang helps keep the document accessible to as large an audience as possible.

Bad
Next, fire up whatever tool you use to browse the web and point it in the direction of ...

Good
Next, start your web browser and navigate to ...

### Avoid contractions

We can never be sure the level of comfort with a language a reader has, contractions increase the difficulty for non native speakers or readers of a language

Bad

We've, you're, don't

Good

We have, you are, do not



### Use direct commands

When providing step-by-step instructions, use direct commands or requests. Avoid
the use of “we” and “let’s”.

Bad
Now let’s add a shapefile by ...

Good
Add a shapefile by ...

received as feedback:

do not use "In this chapter we will"


Naming conventions
-------------------------------

### Capitalization of page names

Each word in the page name should be capitalized except for articles (such as “the”, “a”, “an”) and conjunctions (such as “and”, “but”, “or”). A page name should never start with an article.

Bad
Adding a shapefile or postgis table
Good
Adding a Shapefile or PostGIS Table
Bad
The Shapefile Tutorial
Good
Shapefile Tutorial

### Capitalization of section names

Do not capitalize second and subsequent words unless the title is almost always
capitalized in English (like proper names). Thus, capitalize John Wayne and Art
Nouveau, but not Video Games.

Bad
Creating a New Datastore
Good
Creating a new datastore

#### Verb usage

It is recommended that the gerund (the -ing form in English) be used unless there
is a more common noun form. For example, an article on swimming is better than one
on swim.

Bad
Create a new datastore
Good
Creating a new datastore

### Avoid plurals

Create page titles that are in the singular. Exceptions to this are nouns that are
always plural (scissors, trousers), a small class that requires a plural (polar
coordinates, Bantu languages, The Beatles).

Bad
Templates tutorial
Good
Template tutorial

GUI convention
-----------------------------------
The GUI convention styles are intended to mimic the appearance of the GUI. In
general, the objective is to use the non-hover appearance, so a user can
visually scan the GUI to find something that looks like the instruction in
the manual.

* Menu and toolbar commands are shown as bold letters and (if available)
preceded by an icon image, for example, **File** `image`.

* A series of commands are written with `>`.
For example: **File** > **New Project**.

* Keystroke combinations are shown as `Ctrl+B`, which means press and hold
the `Ctrl` key and then press the `B` key.

* Code or variables are indicated by a fixed-width font, for example:

some commands or variables here


* Note, Text within this box indicates a tip, suggestion, warning or caution.

* Indicate in the instructions if the GUI is platform specific (Windows, Linux or Mac).

Formatting
------------------

Refer to Markdown post guidelines.

https://github.com/hotosm/learnosm/wiki/Markdown-post-guidelines

http://daringfireball.net/projects/markdown/syntax


Attribution of images and screen-shots
--------------------------------------------------------------
Not sure how: hotosm/learnosm#198

Outline of module/topic sections
-------------------------------------------------------------

Overview - discuss what briefly what this section is about and the expected outcome

Detailed steps

Summary


Illustrations and Images
----------------------------------

### Labeling images

Images should be labeled with numbers and arrows pointing to the specific parts of the image the number references. Below the image the numbers should be repeated with the textual description of what the arrow is pointing to in the image. Text labels or descriptions should never be part of the image itself. This is done so image label translations are easier and it is less likely a new image will have to be generated for every language, although that might still be required if the interface in the image needs to be in the local language.

References
==============
* GNOME Style Guide - https://developer.gnome.org/gdp-style-guide/stable/
* Geoserver Style Guide - http://docs.geoserver.org/latest/en/docguide/style.html
* Documenting Python - http://docs.python.org/devguide/documenting.html
* GH Issue on the topic - hotosm/learnosm#82
Binary file added images/contribute/choose_your_fork_to_compare.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/contribute/comment_your_pull_request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/contribute/creating_new_pull_request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/contribute/new_content_uploaded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 346938b

Please sign in to comment.