mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-05 14:10:19 +03:00
404 lines
18 KiB
Plaintext
404 lines
18 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2014-2019, Juan Linietsky, Ariel Manzur and the Godot community (CC-BY 3.0)
|
|
# This file is distributed under the same license as the Godot Engine package.
|
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: Godot Engine latest\n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2019-09-02 11:13+0200\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:4
|
|
msgid "Docs writing guidelines"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:6
|
|
msgid "The Godot community is rich and international. Users come from all around the world. Some of them are young, and many aren't native English speakers. That's why we must all write using a clear and a common language. For the class reference, the goal is to make it easy to read for everyone and precise."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:12
|
|
msgid "In summary, always try to:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:14
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:39
|
|
msgid "Use the direct voice"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:15
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:74
|
|
msgid "Use precise action verbs"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:16
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:96
|
|
msgid "Avoid verbs that end in -ing"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:17
|
|
msgid "Remove unnecessary adverbs and adjectives."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:18
|
|
msgid "Ban these 8 words: obvious, simple, basic, easy, actual, just, clear, and however"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:19
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:210
|
|
msgid "Use explicit references"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:20
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:231
|
|
msgid "Use 's to show possession"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:21
|
|
msgid "Use the Oxford comma"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:23
|
|
msgid "There are 3 rules to describe classes:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:25
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:278
|
|
msgid "Give an overview of the node in the brief description"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:26
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:307
|
|
msgid "Mention what methods return if it's useful"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:27
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:332
|
|
msgid "Use \"if true\" to describe booleans"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:31
|
|
msgid "A technical writer's job is to pack as much information as possible into the smallest and clearest sentences possible. These guidelines will help you work towards that goal."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:36
|
|
msgid "7 rules for a clear english"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:41
|
|
msgid "Use the direct voice when possible. Take the classes, methods, and constants you describe as the subject. It's natural to write using the passive voice, but it's harder to read and produces longer sentences."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:47
|
|
msgid "Passive:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:53
|
|
msgid "Active:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:59
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:313
|
|
msgid "**Don't** use the passive voice:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:66
|
|
msgid "**Do** use the node's name as a noun:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:76
|
|
msgid "Favor precise yet common verbs over generic ones like ``make``, ``set``, and any expression you can replace with a single word."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:79
|
|
msgid "**Don't** repeat the method's name. It already states it sets the pivot value to a new one:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:87
|
|
msgid "**Do** explain what's the consequence of this \"set\": use precise verbs like ``place``, ``position``, ``rotate``, ``fade``, etc."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:98
|
|
msgid "The progressive forms describe continuous actions. E.g. \"is calling\", \"is moving\"."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:101
|
|
msgid "**Don't** use the progressive form for instant changes."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:108
|
|
msgid "**Do** use simple present, preterit or future."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:115
|
|
msgid "You may use the progressive tense to describe actions that are continuous in time. Anything like animation or coroutines."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:120
|
|
msgid "Verbs can turn into adjectival nouns with -ing. This is not a conjugation, so you may use them: ``the remaining movement``, ``the missing file``, etc."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:125
|
|
msgid "Remove unnecessary adverbs and adjectives"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:127
|
|
msgid "Write as few adjectives and adverbs as possible. Only use them if they add key information to the description."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:130
|
|
msgid "**Don't** use redundant or meaningless adverbs. Words that lengthen the documentation but don't add any information:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:137
|
|
msgid "**Do** write short sentences in a simple, descriptive language:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:144
|
|
msgid "Ban these 8 words"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:146
|
|
msgid "**Don't** ever use these 8 banned words:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:148
|
|
msgid "obvious"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:149
|
|
msgid "simple"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:150
|
|
msgid "basic"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:151
|
|
msgid "easy"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:152
|
|
msgid "actual"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:153
|
|
msgid "just"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:154
|
|
msgid "clear"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:155
|
|
msgid "however (some uses)"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:157
|
|
msgid "Game creation and programming aren't simple, and nothing's easy to someone learning to use the API for the first time. Other words in the list, like ``just`` or ``actual`` won't add any info to the sentence. Don't use corresponding adverbs either: obviously, simply, basically, easily, actually, clearly."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:163
|
|
msgid "**Don't** example. The banned words lengthen the description and take attention away from the most important info:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:171
|
|
msgid "**Do** remove them:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:178
|
|
msgid "\"Simple\" never helps. Remember, for other users, anything could be complex or frustrate them. There's nothing like a good old *it's simple* to make you cringe. Here's the old brief description, the first sentence on the Timer node's page:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:188
|
|
msgid "**Do** explain what the node does instead:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:195
|
|
msgid "**Don't** use \"basic\", it is too vague:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:202
|
|
msgid "**Do** use the brief description to offer an overview of the node:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:212
|
|
msgid "Favor explicit references over implicit ones."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:214
|
|
msgid "**Don't** use words like \"the former\", \"the latter\", etc. They're not the most common in English, and they require you to check the reference."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:221
|
|
msgid "**Do** repeat words. They remove all ambiguity:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:227
|
|
msgid "If you need to repeat the same variable name 3 or 4 times, you probably need to rephrase your description."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:233
|
|
msgid "Avoid \"The milk **of** the cow\". It feels unnatural in English. Write \"The cow's milk\" instead."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:236
|
|
msgid "**Don't** write \"of the X\":"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:242
|
|
msgid "**Do** use ``'s``. It lets you put the main subject at the start of the sentence, and keep it short:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:250
|
|
msgid "Use the Oxford comma to enumerate anything"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:252
|
|
msgid "From the Oxford dictionary:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:254
|
|
msgid "The 'Oxford comma' is an optional comma before the word 'and' at the end of a list: *We sell books, videos, and magazines.*"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:257
|
|
msgid "[...] Not all writers and publishers use it, but it can clarify the meaning of a sentence when the items in a list are not single words: *These items are available in black and white, red and yellow, and blue and green.*"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:260
|
|
msgid "**Don't** leave the last element of a list without a comma:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:266
|
|
msgid "**Do** add a comma before `and` or `or`, for the last element of a list with more than two elements."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:275
|
|
msgid "How to write methods and classes"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:280
|
|
msgid "The brief description is the reference's most important sentence. It's the user's first contact with a node:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:283
|
|
msgid "It's the only description in the \"Create New Node\" dialog."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:284
|
|
msgid "It's at the top of every page in the reference"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:286
|
|
msgid "The brief description should explain the node's role and its functionality, in up to 200 characters."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:289
|
|
msgid "**Don't** write tiny and vague summaries:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:296
|
|
msgid "**Do** give an overview of the node's functionality:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:303
|
|
msgid "Use the node's full description to provide more information, and a code example, if possible."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:309
|
|
msgid "Some methods return important values. Describe them at the end of the description, ideally on a new line. No need to mention the return values for any method whose name starts with ``set`` or ``get``."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:320
|
|
msgid "**Do** always use \"Returns\"."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:327
|
|
msgid "Notice the exception to the \"direct voice\" rule: with the move method, an external collider can influence the method and the body that calls ``move``. In this case, you can use the passive voice."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:334
|
|
msgid "For boolean member variables, always use ``if true`` and/or ``if false``, to stay explicit. ``Controls whether or not`` may be ambiguous and won't work for every member variable."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:338
|
|
msgid "Also surround boolean values, variable names and methods with ``[code][/code]``."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:340
|
|
msgid "**Do** start with \"if true\":"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:349
|
|
msgid "Use ``[code]`` around arguments"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:351
|
|
msgid "In the class reference, always surround arguments with ``[code][/code]``. In the documentation and in Godot, it will display like ``this``. When you edit XML files in the Godot repository, replace existing arguments written like 'this' or \\`this\\` with ``[code]this[/code]``."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:355
|
|
msgid "Common vocabulary to use in godot's docs"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:357
|
|
msgid "The developers chose some specific words to refer to areas of the interface. They're used in the sources, in the documentation, and you should always use them instead of synonyms, so the users know what you're talking about."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:365
|
|
msgid "Overview of the interface and common vocabulary"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:367
|
|
msgid "In the top left corner of the editor lie the ``main menus``. In the center, the buttons change the ``workspace``. And together the buttons in the top right are the ``playtest buttons``. The area in the center, that displays the 2D or the 3D space, is the ``viewport``. At its top, you find a list of ``tools`` inside the ``toolbar``."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:373
|
|
msgid "The tabs or dockable panels on either side of the viewport are ``docks``. You have the ``FileSystem dock``, the ``Scene dock`` that contains your scene tree, the ``Import dock``, the ``Node dock``, and the ``Inspector`` or ``Inspector dock``. With the default layout you may call the tabbed docks ``tabs``: the ``Scene tab``, the ``Node tab``..."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:379
|
|
msgid "The Animation, Debugger, etc. at the bottom of the viewport are ``panels``. Together they make up the ``bottom panels``."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:382
|
|
msgid "Foldable areas of the Inspector are ``sections``. The node's parent class names, which you can't fold, are ``Classes`` e.g. the ``KinematicBody2D class``. And individual lines with key-value pairs are ``properties``. E.g. ``position`` or ``modulate color`` are both ``properties``."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:389
|
|
msgid "Image contribution guidelines"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:391
|
|
msgid "A significant part of the documentation is images, and there are several important guidelines to follow."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:394
|
|
msgid "First, you should always be using the default editor theme and text when taking screenshots."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:396
|
|
msgid "For 3D screenshots use 4xMSAA, enable anisotropic filtering on the projects textures, and set the anisotropic filter quality to 16x in Project Settings"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:399
|
|
msgid "Screenshot size should not exceed 1920x1080."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:401
|
|
msgid "When you need to highlight an area of the editor to show something, like a button or option, use a 2 pixel thick outline without a bevel."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/docs_writing_guidelines.rst:404
|
|
msgid "Before you add or replace any images in the documentation, they should be run through a png compressor to save size. The built in lossless compressor in programs like Krita or Photoshop should be done. However you should also use a lossy one, such as `pngquant <https://pngquant.org/>`_ where almost no image quality is lost during compression."
|
|
msgstr ""
|
|
|