godotengine/godot-docs-l10n
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs-l10n.git synced 2026-01-04 10:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
b0a37ce3ecbbb9b77e8b44180d16e1e5f42b9d47
godot-docs-l10n/sphinx/templates/community/contributing/updating_the_class_reference.pot
Rémi Verschelde b0a37ce3ec Sync Sphinx and Weblate templates with current docs
2021-11-19 11:11:47 +01:00

526 lines
22 KiB
Plaintext
Raw Blame History

# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2014-2021, 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 3.4\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2021-11-19 11:09+0100\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/updating_the_class_reference.rst:4
msgid "Contributing to the class reference"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:8
msgid "This guide also is available as a `video tutorial on YouTube <https://www.youtube.com/watch?v=5jeHXxeX-JY>`_."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:10
msgid "Godot ships with many nodes and singletons to help you develop your games. Each is a class, documented in the :ref:`class reference <toc-class-ref>`. This reference is essential for anyone learning the engine: it is available both online and in the engine."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:13
msgid "But it's incomplete. Some methods, variables and signals lack descriptions. Others changed with recent releases and need updates. The developers can't write the entire reference on their own. Godot needs you, and all of us, to contribute."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:16
msgid "**Important:** If you are planning to make larger changes or a more substantial contribution, it is usually a good idea to create an issue (or a comment in an existing one) to let others know so they don't start working on the same thing too."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:21
msgid "Not sure where to start contributing? Take a look at the current class reference completion status `here <https://godotengine.github.io/doc-status/>`__."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:25
msgid "How to contribute"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:27
msgid "The class reference lies in the following XML files, in Godot's GitHub repository: `doc/classes/ <https://github.com/godotengine/godot/tree/master/doc/classes>`_."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:29
msgid "There are 5 steps to update the class reference (full guide below):"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:31
msgid "Fork `Godot's repository <https://github.com/godotengine/godot>`_"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:32
msgid "Clone your fork on your computer"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:33
msgid "Edit the class file in ``doc/classes/`` to write documentation"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:34
msgid "Commit your changes and push them to your fork"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:35
msgid "Make a pull request on the Godot repository"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:37
msgid "Always use these XML files to edit the API reference. Do not edit the generated .rst files :ref:`in the online documentation <toc-class-ref>`, hosted in the `godot-docs <https://github.com/godotengine/godot-docs>`_ repository."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:40
msgid "Get started with GitHub"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:42
msgid "If you're new to Git and GitHub, this guide will help you get started. You'll learn to:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:44
msgid "Fork and clone Godot's repository"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:45
msgid "Keep your fork up to date with other contributors"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:46
msgid "Create a pull request so your improvements end in the official docs"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:48
msgid "If you're new to Git, the version control system Godot uses, go through `GitHub's interactive guide <https://try.github.io/levels/1/challenges/1>`_. You'll learn some essential vocabulary and get a sense for the tool."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:51
msgid "Fork Godot"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:53
msgid "Fork the Godot Engine into a GitHub repository of your own."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:55
msgid "Clone the repository on your computer:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:61
msgid "Create a new branch to make your changes. It makes it a lot easier to sync your improvements with other docs writers. It's also easier to clean up your repository if you run into any issues with Git."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:67
msgid "The new branch is the same as your master branch, until you start to write API docs. In the ``doc/`` folder, you'll find the class reference."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:70
msgid "How to keep your local clone up-to-date"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:72
msgid "Other writers contribute to Godot's documentation. Your local repository will fall behind it, and you'll have to synchronize it. Especially if other contributors update the class reference while you work on it."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:74
msgid "First add an ``upstream`` git *remote* to work with. Remotes are links to online repositories you can download new files from."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:80
msgid "You can check the list of all remote servers with:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:86
msgid "You should have two: ``origin``, your fork on GitHub that Git adds by default, and ``upstream``, that you just added:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:96
msgid "Each time you want to sync your branch to the state of the upstream repository, enter:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:102
msgid "This command will first ``fetch``, or download the latest version of the Godot repository. Then, it will reapply your local changes on top."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:104
msgid "If you made changes you don't want to keep in your local branch, use the following commands instead:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:111
msgid "**Warning:** The above command will reset your branch to the state of the ``upstream master`` branch. It will discard all local changes. Make sure to only run this *before* you make important changes."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:113
msgid "Another option is to delete the branch you're working on, synchronize the master branch with the Godot repository, and create a new branch:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:122
msgid "If you're feeling lost by now, come to our `IRC channels <https://webchat.freenode.net/?channels=#godotengine>`_ and ask for help. Experienced Git users will give you a hand."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:125
msgid "Updating the documentation template"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:127
msgid "When classes are modified in the source code, the documentation template might become outdated. To make sure that you are editing an up-to-date version, you first need to compile Godot (you can follow the :ref:`doc_introduction_to_the_buildsystem` page), and then run the following command (assuming 64-bit Linux):"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:133
msgid "The XML files in doc/classes should then be up-to-date with current Godot Engine features. You can then check what changed using the ``git diff`` command. If there are changes to other classes than the one you are planning to document, please commit those changes first before starting to edit the template:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:140
msgid "You are now ready to edit this file to add stuff."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:142
msgid "**Note:** If this has been done recently by another contributor, you don't forcefully need to go through these steps (unless you know that the class you plan to edit *has* been modified recently)."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:145
msgid "Push and request a pull of your changes"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:147
msgid "Once your modifications are finished, push your changes on your GitHub repository:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:156
msgid "When it's done, you can ask for a Pull Request via the GitHub UI of your Godot fork."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:160
msgid "Although you can edit files on GitHub, it's not recommended. As hundreds of contributors work on Godot, the Git history must stay clean. Each commit should bundle all related improvements you make to the class reference, a new feature, bug fixes... When you edit from GitHub, it will create a new branch and a Pull Request every time you want to save it. If a few days pass before your changes get a review, you won't be able to update to the latest version of the repository cleanly. Also, it's harder to keep clean indents from GitHub. And they're very important in the docs."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:162
msgid "TL;DR: If you don't know what you're doing exactly, do not edit files from GitHub."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:165
msgid "How to edit class XML"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:167
msgid "Edit the file for your chosen class in ``doc/classes/`` to update the class reference. The folder contains an XML file for each class. The XML lists the constants and methods you'll find in the class reference. Godot generates and updates the XML automatically."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:169
msgid "Edit it using your favorite text editor. If you use a code editor, make sure that it doesn't change the indent style: tabs for the XML, and 4 spaces inside BBCode-style blocks. More on that below."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:171
msgid "If you need to check that the modifications you've made are correct in the generated documentation, build Godot as described :ref:`here <toc-devel-compiling>`, run the editor and open the help for the page you modified."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:174
msgid "How to write the class reference"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:176
msgid "Each class has a brief and a long description. The brief description is always at the top of the page, while the full description lies below the list of methods, variables and constants. Methods, member variables, constants and signals are in separate categories or XML nodes. For each, learn how they work in Godot's source code, and fill their <description>."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:178
msgid "Our job is to add the missing text between these marks:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:180
msgid "<description></description>"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:181
msgid "<brief_description></brief_description>"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:182
msgid "<constant></constant>"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:183
msgid "<method></method>"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:184
msgid "<member></member>"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:185
msgid "<signal></signal>"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:187
msgid "Write in a clear and simple language. Always follow the :ref:`writing guidelines <doc_docs_writing_guidelines>` to keep your descriptions short and easy to read. **Do not leave empty lines** in the descriptions: each line in the XML file will result in a new paragraph."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:189
msgid "Here's how a class looks like in XML:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:228
msgid "Use a code editor like Vim, Atom, Code, Notepad++ or anything similar to edit the file quickly. Use the search function to find classes fast."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:233
msgid "Improve formatting with BBCode style tags"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:235
msgid "Godot's class reference supports BBCode-like tags. They add nice formatting to the text. Here's the list of available tags:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:238
msgid "Tag"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:238
msgid "Effect"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:238
msgid "Usage"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:238
msgid "Result"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:240
msgid "[Class]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:240
msgid "Link a class"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:240
msgid "Move the [Sprite]."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:240
msgid "Move the :ref:`class_sprite`."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:242
msgid "[method methodname]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:242
msgid "Link to a method in this class"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:242
msgid "Call [method hide]."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:242
#: ../../docs/community/contributing/updating_the_class_reference.rst:244
msgid "See :ref:`hide <class_spatial_method_hide>`."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:244
msgid "[method Class.methodname]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:244
msgid "Link to another class's method"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:244
msgid "Call [method Spatial.hide]."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:246
msgid "[member membername]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:246
msgid "Link to a member in this class"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:246
msgid "Get [member scale]."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:246
#: ../../docs/community/contributing/updating_the_class_reference.rst:248
msgid "Get :ref:`scale <class_node2d_property_scale>`."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:248
msgid "[member Class.membername]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:248
msgid "Link to another class's member"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:248
msgid "Get [member Node2D.scale]."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:250
msgid "[signal signalname]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:250
msgid "Link to a signal in this class"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:250
msgid "Emit [signal renamed]."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:250
#: ../../docs/community/contributing/updating_the_class_reference.rst:252
msgid "Emit :ref:`renamed <class_node_signal_renamed>`."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:252
msgid "[signal Class.signalname]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:252
msgid "Link to another class's signal"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:252
msgid "Emit [signal Node.renamed]."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:254
msgid "[b] [/b]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:254
msgid "Bold"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:254
msgid "Some [b]bold[/b] text."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:254
msgid "Some **bold** text."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:256
msgid "[i] [/i]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:256
msgid "Italic"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:256
msgid "Some [i]italic[/i] text."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:256
msgid "Some *italic* text."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:258
msgid "[code] [/code]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:258
msgid "Monospace"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:258
msgid "Some [code]monospace[/code] text."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:258
msgid "Some ``monospace`` text."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:260
msgid "[kbd] [/kbd]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:260
msgid "Keyboard/mouse shortcut"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:260
msgid "Some [kbd]Ctrl + C[/kbd] key."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:260
msgid "Some :kbd:`Ctrl + C` key."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:262
msgid "[codeblock] [/codeblock]"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:262
msgid "Multiline preformatted block"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:262
#: ../../docs/community/contributing/updating_the_class_reference.rst:262
msgid "*See below.*"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:265
msgid "Use ``[codeblock]`` for pre-formatted code blocks. Inside ``[codeblock]``, always use **four spaces** for indentation (the parser will delete tabs). Example:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:275
msgid "Will display as:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:283
msgid "To denote important information, add a paragraph starting with \"[b]Note:[/b]\" at the end of the description:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:290
msgid "To denote crucial information that could cause security issues or loss of data if not followed carefully, add a paragraph starting with \"[b]Warning:[/b]\" at the end of the description:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:298
msgid "For deprecated properties, add a paragraph starting with \"[i]Deprecated.[/i]\". Notice the use of italics instead of bold:"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:305
msgid "In all the paragraphs described above, make sure the punctuation is part of the BBCode tags for consistency."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:309
msgid "I don't know what this method does!"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:311
msgid "No problem. Leave it behind, and list the methods you skipped when you request a pull of your changes. Another writer will take care of it."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:313
msgid "You can still have a look at the methods' implementation in Godot's source code on GitHub. Also, if you have doubts, feel free to ask on the `Q&A website <https://godotengine.org/qa/>`__ and on IRC (freenode, #godotengine)."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:317
msgid "Localization"
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:319
msgid "The documentation can be translated in any language on `Hosted Weblate <https://hosted.weblate.org/projects/godot-engine/godot-docs/>`__."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:322
msgid "Translated strings are synced manually by documentation maintainers in the `godot-docs-l10n <https://github.com/godotengine/godot-docs-l10n>`__ repository."
msgstr ""
#: ../../docs/community/contributing/updating_the_class_reference.rst:326
msgid "Languages with a good level of completion have their own localized instances of ReadTheDocs. Open an issue on the ``godot-docs-l10n`` repository if you think that a new language is complete enough to get its own instance."
msgstr ""
Reference in New Issue View Git Blame Copy Permalink