mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
166 lines
8.7 KiB
Plaintext
166 lines
8.7 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2014-2022, 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.5\n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2022-09-09 16:03+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/documentation_guidelines.rst:4
|
|
msgid "Documentation guidelines"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:6
|
|
msgid "This page describes the rules to follow if you want to contribute to Godot Engine by writing or reviewing documentation, or by translating existing documentation. Also, have a look at README of the `godot-docs GitHub repository <https://github.com/godotengine/godot-docs>`_ and the `docs front page <https://docs.godotengine.org>`_ on what steps to follow and how to contact the docs team."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:14
|
|
msgid "How to contribute"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:16
|
|
msgid "Creating or modifying documentation pages is mainly done via the `godot-docs GitHub repository <https://github.com/godotengine/godot-docs>`_. The HTML (or PDF and EPUB) documentation is generated from the .rst files (reStructuredText markup language) in that repository. Modifying those pages in a pull request and getting it merged will trigger a rebuild of the online documentation."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:23
|
|
msgid "For details on Git usage and the pull request workflow, please refer to the :ref:`doc_pr_workflow` page. Most of what it describes regarding the main godotengine/godot repository is also valid for the docs repository."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:28
|
|
msgid "The class reference's source files are in the `Godot engine repository <https://github.com/godotengine/godot>`_. We generate the :ref:`Godot API <toc-class-ref>` section of this documentation from them. If you want to update the description of a class, its methods, or properties, read :ref:`doc_updating_the_class_reference`."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:34
|
|
msgid "If you want to edit the **API reference**, please note that it should *not* be done in the godot-docs repository. Instead, you should edit the ``doc/classes/*`` XML files of Godot's main repository. These files are then later used to generate the in-editor documentation as well as the API reference of the online docs. Read more here: :ref:`doc_updating_the_class_reference`."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:42
|
|
msgid "The 'Edit on GitHub' link"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:44
|
|
msgid "If you're reading documentation on `docs.godotengine.org <https://docs.godotengine.org>`_, you'll see an **Edit on GitHub** hyperlink at the top right of the page. Once you've created a GitHub account, you can propose changes to a page you're reading as follows:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:49
|
|
msgid "Click the **Edit on GitHub** button."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:51
|
|
msgid "On the GitHub page you're taken to, click the pencil icon in the top-right corner near the **Raw**, **Blame** and **History** buttons. It has the tooltip \"Edit the file in a fork of this project\"."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:55
|
|
msgid "Complete all the edits you want to make for that page."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:57
|
|
msgid "Summarize the changes you made in the form at the bottom of the page and click the button labelled **Propose file change** when done."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:60
|
|
msgid "On the following screens, click the **Create pull request** button until you see a message like *Username wants to merge 1 commit into godotengine:master from Username:patch-6*."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:64
|
|
msgid "A reviewer will evaluate your changes and incorporate them into the docs if they're acceptable. You might also be asked to make modifications to your changes before they're included."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:69
|
|
msgid "What makes good documentation?"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:71
|
|
msgid "Documentation should be well written in plain English, using well-formed sentences and various levels of sections and subsections. It should be clear and objective. Also, have a look at the :ref:`doc_docs_writing_guidelines`."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:75
|
|
msgid "We differentiate tutorial pages from other documentation pages by these definitions:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:78
|
|
msgid "Tutorial: a page aiming at explaining how to use one or more concepts in the editor or scripts in order to achieve a specific goal with a learning purpose (e.g. \"Making a simple 2d Pong game\", \"Applying forces to an object\")."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:82
|
|
msgid "Documentation: a page describing precisely one and only one concept at a time, if possible exhaustively (e.g. the list of methods of the Sprite class, or an overview of the input management in Godot)."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:86
|
|
msgid "You are free to write the kind of documentation you wish, as long as you respect the following rules (and the ones on the repo)."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:90
|
|
msgid "Titles"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:92
|
|
msgid "Always begin pages with their title and a Sphinx reference name:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:101
|
|
msgid "The reference allows linking to this page using the ``:ref:`` format, e.g. ``:ref:`doc_insert_your_title_here``` would link to the above example page (note the lack of leading underscore in the reference)."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:105
|
|
msgid "Also, avoid American CamelCase titles: title's first word should begin with a capitalized letter, and every following word should not. Thus, this is a good example:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:109
|
|
msgid "Insert your title here"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:111
|
|
msgid "And this is a bad example:"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:113
|
|
msgid "Insert Your Title Here"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:115
|
|
msgid "Only project, people and node class names should have capitalized first letter."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:119
|
|
msgid "Translating existing pages"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:121
|
|
msgid "You can help to translate the official Godot documentation on our `Hosted Weblate <https://hosted.weblate.org/engage/godot-engine/>`_."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:None
|
|
msgid "Translation state"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:130
|
|
msgid "There also is the official `Godot i18n repository <https://github.com/godotengine/godot-docs-l10n>`_ where you can see when the data was last synchronized."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:135
|
|
msgid "License"
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:137
|
|
msgid "This documentation and every page it contains is published under the terms of the `Creative Commons Attribution 3.0 license (CC-BY-3.0) <https://tldrlegal.com/license/creative-commons-attribution-(cc)>`_, with attribution to \"Juan Linietsky, Ariel Manzur and the Godot community\"."
|
|
msgstr ""
|
|
|
|
#: ../../docs/community/contributing/documentation_guidelines.rst:140
|
|
msgid "By contributing to the documentation on the GitHub repository, you agree that your changes are distributed under this license."
|
|
msgstr ""
|
|
|
|
#: ../../docs/<rst_epilog>:0
|
|
msgid "Translation status"
|
|
msgstr ""
|