1742 lines
74 KiB
Plaintext
1742 lines
74 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
||
# Copyright (C) Odoo S.A.
|
||
# This file is distributed under the same license as the Odoo package.
|
||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||
#
|
||
#, fuzzy
|
||
msgid ""
|
||
msgstr ""
|
||
"Project-Id-Version: Odoo 14.0\n"
|
||
"Report-Msgid-Bugs-To: \n"
|
||
"POT-Creation-Date: 2022-03-18 13:48+0000\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"
|
||
|
||
#: ../../content/contributing.rst:5
|
||
msgid "Contributing"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:5
|
||
msgid "Write documentation"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:14
|
||
msgid "**First of all, thank you for landing here and helping us improve the user documentation of Odoo!**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:16
|
||
msgid "This introductory guide will help you acquire the tools and knowledge you need to write documentation, whether you plan to make a minor content change or document an application from scratch."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:23
|
||
msgid "reStructuredText"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:25
|
||
msgid "Our documentation is written in **reStructuredText** (RST), a `lightweight markup language <https://en.wikipedia.org/wiki/Lightweight_markup_language>`_ consisting of normal text augmented with markup which allows including headings, images, notes, and so on. This might seem a bit abstract but there is no need to worry. :abbr:`RST (reStructuredText)` is not hard to learn, especially if you intend to make only small changes to the content."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:31
|
||
msgid "If you need to learn about a specific markup, head over to :doc:`our cheat sheet for RST <documentation/rst_cheat_sheet>` which contains all the information that you should ever need for the user documentation of Odoo."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:36
|
||
msgid "We kindly ask you to observe a set of :doc:`content <documentation/content_guidelines>` and :doc:`RST <documentation/rst_guidelines>` guidelines as you write documentation. This ensures that you stay consistent with the rest of the documentation and facilitates the approval of your content changes as they are reviewed by a redactor at Odoo."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:42
|
||
msgid ":doc:`documentation/content_guidelines`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:43
|
||
msgid ":doc:`documentation/rst_cheat_sheet`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:44
|
||
msgid ":doc:`documentation/rst_guidelines`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:49
|
||
msgid "Getting started"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:51
|
||
msgid "As our documentation is maintained on GitHub, you will need a free GitHub account. Click `here <https://github.com/join>`_ to create one."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:54
|
||
msgid "Now, depending on whether you want to update existing content, or rather work on new content and make file changes, you have two courses of action:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:57
|
||
msgid "**For small changes** in ``.rst`` files only, i.e. addition/edition of paragraphs or typos, **we suggest that you use the GitHub interface**. This is the easiest and fasted way to submit your request for changes for the documentation and is suitable for non-technical people. Read :ref:`contributing/github-interface` to learn how to use this method."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:61
|
||
msgid "**For more complex cases**, it is necessary to **use Git and work from a local copy of the documentation**. This method seems intimidating but only requires basic knowledge of Git. See :ref:`contributing/canonical-git-workflow` for more information on this method."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:68
|
||
msgid "Use the GitHub interface"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:70
|
||
msgid "Verify that you are browsing the documentation in the version that you intend to change. The version can be selected from the dropdown in the top menu."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:73
|
||
msgid "Head over to the page that you want to change and click on the **Edit on GitHub** button in the top right corner of the page."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:76
|
||
msgid "If you do not have edit rights on the repository (`odoo/documentation <https://github.com/odoo/documentation>`_), you need to fork it by clicking on the appropriate button. In other terms, you create a copy of the entire repository on your own account. If you do have the edit rights, skip this step."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:83
|
||
msgid "Make the appropriate changes while taking care of following the :doc:`content <documentation/content_guidelines>` and :doc:`RST <documentation/rst_guidelines>` guidelines."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:86
|
||
msgid "Click on the **Preview changes** button to review your contribution in a more human-readable format. Be aware that the preview is not able to handle all markups correctly. Notes and tips, for instance, are not correctly rendered. The version of your content published to the website will be, however."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:91
|
||
msgid "Go to the bottom of the page to create a commit (:dfn:`what packs your changes together and labels them with a commit message`) of your changes."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:0
|
||
msgid "In first text box, describe your changes. For instance, \"Fix a typo\" and \"Add documentation for invoicing of sales orders\" are two clear commit messages."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:0
|
||
msgid "In the second text box, justify *why* you made these changes, if you feel that it is not obvious."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:98
|
||
msgid "Select the option \"Create a new branch for this commit and start a pull request.\" if you have the choice (if you have partial or full edit writes on the repository). If not, skip this step."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:101
|
||
msgid "Click on the green button. It is either labelled \"Commit changes\" or \"Propose file change\"."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:105
|
||
msgid "In the dropdown for the selection of the base branch (i.e., the version of the documentation that your changes concern), make sure to select the same version as in the first step of this guide and click on the **Create pull request** button."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:111
|
||
msgid "Double-check your :abbr:`PR (Pull Request)` and, when ready, click again on the **Create pull request** button to submit your changes for review by a content writer at Odoo."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:116
|
||
#: ../../content/contributing/documentation.rst:395
|
||
msgid "You're done! If your changes are approved straight away they will appear in the documentation the very next day. It may also be the case that the reviewer has a question or a remark, so make sure to check your notifications or your emails, depending on your account settings."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:123
|
||
msgid "Use the canonical Git workflow"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:128
|
||
msgid "Prepare your machine"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:133
|
||
msgid "Install Git"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:135
|
||
msgid "We use `Git <https://en.wikipedia.org/wiki/Git>`_ to manage the files of the user documentation. It is a tool that allows to track the history of changes made to a file and, more importantly, to work on different versions of those files at the same time. It means that you do not need to worry about overwriting someone else’s pending work when you start editing the documentation."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:140
|
||
msgid "You must then configure Git to identify yourself as the author of your future contribution. Enter the same email address as the one you used to register on GitHub."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:143
|
||
msgid "Download and install **Git** on your machine."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:144
|
||
msgid "Verify that `the installation folder of Git is included in your system's PATH variable <win-add-to-path_>`_."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:146
|
||
#: ../../content/contributing/documentation.rst:171
|
||
#: ../../content/contributing/documentation.rst:319
|
||
#: ../../content/contributing/documentation.rst:336
|
||
#: ../../content/contributing/documentation.rst:367
|
||
msgid "Execute the following commands in a terminal:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:156
|
||
msgid "Fetch the sources"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:158
|
||
msgid "As stated earlier, our documentation (in all its versions) is maintained on GitHub at `github.com/odoo/documentation <https://github.com/odoo/documentation>`_. A modification is made by the mean of a :abbr:`PR (Pull Request)` (:dfn:`proposal of content changes`) to allow for a review of the changes before updating the sources of the documentation."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:163
|
||
msgid "Prior to submitting a modification, you need to make a copy of the sources and download that copy on your machine."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:166
|
||
msgid "Go to `github.com/odoo/documentation <https://github.com/odoo/documentation>`_ and click on the **Fork** button in the top right corner."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:179
|
||
msgid "If you do not have edit rights on the repository owned by Odoo, replace \"odoo\" with your Github username in the URL of the command above. If you do have edit rights, it is not necessary to fork the repository."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:183
|
||
msgid "In order to ease the collaboration between writers coming from many different systems and teams, execute the following group of commands that correspond to your :abbr:`OS (Operating System)` in a terminal."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:187
|
||
msgid "Windows:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:195
|
||
msgid "Linux or Mac OS:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:206
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:742
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:744
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:760
|
||
msgid "Python"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:208
|
||
msgid "Because the documentation is written in :abbr:`RST (reStructuredText)`, it needs to be built (:dfn:`converted to HTML`) in order to display nicely. This is done by the documentation generator which takes the original :abbr:`RST (reStructuredText)` files as input, transforms the markups in a human-readable format, and outputs HTML files to be read in your web browser."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:213
|
||
msgid "The documentation generator that we use is called `Sphinx <http://www.sphinx-doc.org/en/master/>`_. and is written in `Python <https://en.wikipedia.org/wiki/Python_(programming_language)>`_. You have to install Python in order to use Sphinx. For the record, Sphinx is the program and Python the programming language, but you do not need to know much more about them so don't panic!"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:218
|
||
msgid "Python comes with its own package manager: `pip <https://en.wikipedia.org/wiki/Pip_(package_manager)>`_. It allows installing Python dependencies in a single command."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:222
|
||
msgid "Download and install the recommended release (`see README file <https://github.com/odoo/documentation/tree/14.0/README.md>`_) of **Python 3** on your machine."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:224
|
||
msgid "Make sure to have **pip** installed on your machine (on Windows, you can install pip alongside Python)."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:226
|
||
msgid "Execute the following commands in a terminal to verify that both installations finished successfully:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:234
|
||
msgid "Execute the following commands in a terminal to install the Python dependencies of the documentation:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:243
|
||
msgid "Depending on your :abbr:`OS (Operating System)`, you may need to run the commands ``python`` and ``pip`` instead of ``python3`` and ``pip3``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:249
|
||
msgid "Make"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:251
|
||
msgid "`Make <https://en.wikipedia.org/wiki/Make_(software)>`_ is a tool that packs a bunch of command-lines into one to be easier to remember and to type. In our case, it is used to execute complex Sphinx build commands by using a single and simpler one instead."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:255
|
||
msgid "Download and install **Make** on your machine."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:256
|
||
msgid "Verify that `the installation folder of Make is included in your system's PATH variable <win-add-to-path_>`_."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:262
|
||
msgid "pngquant"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:264
|
||
msgid "`pngquant <https://pngquant.org/>`_ is a tool that we use to compress PNG images so that the documentation does not end up weighting several Gigabytes in a few year span."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:267
|
||
msgid "Download and install **pngquant** on your machine."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:268
|
||
msgid "Verify that `the installation folder of pngquant is included in your system's PATH variable <win-add-to-path_>`_."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:274
|
||
msgid "Prepare your version"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:276
|
||
msgid "Now that your machine is all set up, it is time to do the same for your version of the documentation files. As it would not be convenient to have several people working on the version 13.0 in parallel (conflicts of content would occur all the time), and in order to be able to create a :abbr:`PR (Pull Request)`, you must `create a new branch <https://www.atlassian.com/git/tutorials/using-branches>`_ starting from the branch 13.0. In other words, you copy the entirety of this version’s files and give it another name. For this example, we will go with ``13.0-my_contribution``."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:284
|
||
msgid "Execute the following commands in a terminal to..."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:286
|
||
msgid "Navigate to the documentation folder:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:292
|
||
msgid "Switch to the version 13.0:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:298
|
||
msgid "Create your own branch which will be a copy of 13.0:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:307
|
||
msgid "Perform your changes"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:309
|
||
msgid "You can now perform any change you want to the documentation files. These changes must be compliant with :abbr:`RST (reStructuredText)` syntax (see :doc:`documentation/rst_cheat_sheet`) and with our :doc:`content <documentation/content_guidelines>` and :doc:`RST <documentation/rst_guidelines>` guidelines."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:315
|
||
msgid "If your changes include the addition of a new image, for instance :file:`my_image.png`, proceed as follows:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:318
|
||
msgid "Make sure that the image is in ``.png`` format."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:326
|
||
msgid "Delete :file:`my_image.png`."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:327
|
||
msgid "Rename :file:`my_image-fs8.png` to :file:`my_image.png`."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:332
|
||
msgid "Preview your changes"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:334
|
||
msgid "To preview your changes in a generated documentation, proceed as follows:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:345
|
||
msgid "You can omit the :command:`make clean` command when no recent change has been made to the hierarchy of documentation files."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:348
|
||
msgid "Fix any error or warning shown in the logs of the build."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:349
|
||
msgid "Open the file :file:`documentation/_build/html/index.html` with your default web browser."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:352
|
||
msgid "These steps have for only purpose to show you the final results of your changes. They have no impact on the documentation source files."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:358
|
||
msgid "Submit your changes"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:361
|
||
msgid "We expect you to have basic knowledge of Git, which should be enough to cover the basic flow of a one-time contribution. If you plan on submitting several contributions, work on older versions of the documentation or perform any other advanced action, we recommend you to be confident with Git. Help yourself with `this manual of Git <https://www.atlassian.com/git>`_ and `this interactive tutorial <https://learngitbranching.js.org/>`_."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:375
|
||
msgid "Go to `github.com/odoo/documentation/pulls <https://github.com/odoo/documentation/pulls>`_ and click on the **New pull request** button."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:380
|
||
msgid "If you forked the base repository in the section :ref:`contributing/fetch-sources`, click on the link **compare across forks** If not, skip this step."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:385
|
||
msgid "In the dropdown for the selection of the base branch (i.e., the version of the documentation that your changes concern), make sure to select the version that your changes target (here **13.0**)."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation.rst:390
|
||
msgid "Double-check your :abbr:`PR (Pull Request)` and, when ready, click again on the **Create pull request** button to submit your changes for review by a redactor at Odoo."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:3
|
||
msgid "Content guidelines"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:5
|
||
msgid "To give the community the best documentation possible, we listed here a few guidelines, tips and tricks that will make your content shine at its brightest! While we encourage you to adopt your own writing style, some rules still apply to give the reader more clarity and comprehension."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:10
|
||
msgid "We strongly recommend contributors to carefully read the other documents related to this section of the documentation. Good knowledge of the ins and outs of **RST writing** is required to write and submit your contribution. Note that it also affects your writing style itself."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:14
|
||
msgid ":doc:`../documentation`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:15
|
||
msgid ":doc:`rst_cheat_sheet`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:16
|
||
msgid ":doc:`rst_guidelines`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:21
|
||
msgid "Writing style"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:23
|
||
msgid "**Writing for documentation** isn't the same as writing for a blog or another medium. Readers are more likely to skim read until they've found the information they are looking for. Keep in mind that the user documentation is a place to inform and describe, not to convince and promote."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:30
|
||
msgid "Consistency"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:32
|
||
msgid "*Consistency is key to everything.*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:34
|
||
msgid "Make sure that your writing style remains **consistent**. If you modify an existing text, try to match the existing tone and presentation, or rewrite it to match your own style."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:40
|
||
msgid "Grammatical tenses"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:42
|
||
msgid "In English, descriptions and instructions require the use of a **Present Tense**, while a *future tense* is appropriate only when a specific event is to happen ulteriorly. This logic might be different in other languages."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "Good example (present):"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "*Screenshots are automatically resized to fit the content block's width.*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "Bad example (future):"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "*When you take a screenshot, remember that it will be automatically resized to fit the content block's width.*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:55
|
||
msgid "Paragraphing"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:57
|
||
msgid "A paragraph comprises several sentences that are linked by a shared idea. They usually are two to six lines long."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:60
|
||
msgid "In English, a new idea implies a new paragraph, rather than having a *line break* as it is common to do in some other languages. *Line breaks* are useful for layout purposes but shouldn't be used as a grammatical way of separating ideas."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:65
|
||
msgid ":ref:`RST cheat sheet: Break the line but not the paragraph <contributing/line-break>`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:70
|
||
msgid "Titles and headings"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:72
|
||
msgid "To write good titles and headings:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:74
|
||
msgid "**Be concise.**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:75
|
||
msgid "**Avoid sentences**, questions, and titles starting with \"how to.\""
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:76
|
||
msgid "**Don't use pronouns** in your titles, especially 2nd person (*your*)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:77
|
||
msgid "Use **sentence case**. This means you capitalize only:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:79
|
||
msgid "the first word of the title or heading"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:80
|
||
msgid "the first word after a colon"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:81
|
||
msgid "proper nouns (brands, product and service names, etc.)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:82
|
||
msgid "app features, as written in the apps"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:85
|
||
msgid "Do not capitalize common nouns when they are not referred to as features. This is more likely to happen in headings rather than in titles."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:89
|
||
msgid "Examples"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:89
|
||
msgid "Explanations"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "**Titles**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "(H1)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:91
|
||
msgid "*Quotation Templates*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:91
|
||
msgid "\"Quotation Templates\" is a feature in Odoo."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:93
|
||
msgid "*Lead Mining*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:93
|
||
msgid "\"Lead Mining\" is a feature in Odoo."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:95
|
||
msgid "*Resupply from another Warehouse*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:95
|
||
msgid "\"Warehouse\" is capitalized as we refer to the feature in the app rather than to a real warehouse."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:98
|
||
msgid "*Synchronize Google Calendar with Odoo*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:98
|
||
msgid "\"Google Calendar\" is a product and \"Odoo\" is a brand."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "**Headings**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "(H2, H3, etc.)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:101
|
||
msgid "*Confirm the quotation*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:101
|
||
msgid "\"The quotation\" is a common noun not referring to a feature in Odoo."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:104
|
||
msgid "*Test environment*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:104
|
||
msgid "\"Environment\" is a common noun."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:106
|
||
msgid "*Add a new Payment Acquirer*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:106
|
||
msgid "\"Payment Acquirers\" is a feature in Odoo."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:108
|
||
msgid "*Generate SEPA Direct Debit XML files to submit payments*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:108
|
||
msgid "\"SEPA Direct Debit\" and \"XML\" are considered as proper nouns."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:115
|
||
msgid "Document structure"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:117
|
||
msgid "Use different **heading levels** to organize your text by sections and sub-sections. Your headings are not only displayed in the document but also on the navigation menu (only the H1) and on the \"On this page\" sidebar (all H2 to H6)."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "**H1: Page title**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "Your *page title* gives your reader a quick and clear understanding of what your content is about."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:126
|
||
msgid "The *content* in this section describes the upcoming content from a **business point of view**, and shouldn't put the emphasis on Odoo, as this is documentation and not marketing."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:130
|
||
msgid "Start first with a **lead paragraph**, which helps the reader make sure that they've found the right page, then explain the **business aspects of this topic** in the following paragraphs."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "**H2: Section title (configuration)**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "This first H2 section is about the configuration of the feature, or the prerequisites to achieve a specific goal. To add a path, make sure you use the ``:menuselection:`` specialized directive (see link below)."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "Example:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "To do so, go to ``:menuselection:`App name --> Menu --> Sub-menu```, and enable the XYZ feature."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "**H2: Section title (main sections)**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "Create as many main sections as you have actions or features to distinguish. The title can start with a verb, but try to avoid using \"Create ...\"."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "**H3: Subsection**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:0
|
||
msgid "Subsections are perfect for assessing very specific points. The title can be in the form of a question, if appropriate."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:151
|
||
msgid "**H2: Next Section**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:155
|
||
msgid ":ref:`RST cheat sheet: headings <contributing/headings>`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:156
|
||
msgid ":ref:`RST cheat sheet: specialized directives <contributing/specialized-directives>`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:161
|
||
msgid "Organizing the documentation"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:163
|
||
msgid "When writing documentation about a given topic, try to keep pages within the same folder organized."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:165
|
||
msgid "For most topics, a single page should do the job. Place it in the appropriate section of the documentation (e.g., content related to the CRM app go under :menuselection:`Applications -> Sales -> CRM`) and follow the :ref:`document structure <contributing/document-structure>` guidelines."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:170
|
||
msgid "For more complex topics, you may need several pages to cover all their aspects. Usually, you will find yourself adding documentation to a topic that is already partially covered. In that case, either create a new page and place it at the same level as other related pages or add new sections to an existing page. If you are documenting a complex topic from scratch, organize your content between one parent page (the :abbr:`TOC (Tree Of Contents)` page) and several child pages. Whenever possible, write content on the parent page and not only on the child pages. Make the parent page accessible from the navigation menu by using the :ref:`show-content <contributing/document-metadata>` metadata directive."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:182
|
||
msgid "Images"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:184
|
||
msgid "Adding a few images to illustrate your text helps the readers to understand and memorize your content. However, avoid adding too many images: it isn't necessary to illustrate all steps and features, and it may overload your page."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:189
|
||
msgid "Don't forget to :ref:`compress your PNG files with pngquant <contributing/pngquant>`."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:194
|
||
msgid "Screenshots"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:196
|
||
msgid "Screenshots are automatically resized to fit the content block's width. This implies that screenshots can't be too wide, else they would appear very small on-screen. Therefore, we recommend to avoid to take screenshots of a full screen display of the app, unless it is relevant to do so."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:200
|
||
msgid "A few tips to improve your screenshots:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:202
|
||
msgid "**Zoom** in your browser. We recommend a 110% zoom for better results."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:203
|
||
msgid "**Resize** your browser's width, either by *resizing the window* itself or by opening the *browser's developer tools* (press the ``F12`` key) and resizing the width."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:205
|
||
msgid "**Select** the relevant area, rather than keeping the full window."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:206
|
||
msgid "If necessary, you can **edit** the screenshot to remove unnecessary fields and to narrow even more Odoo's display."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:214
|
||
msgid "Resizing the window's width is the most important step to do as Odoo's responsive design automatically resizes all fields to match the window's width."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:220
|
||
msgid "Media files"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:222
|
||
msgid "A **media filename**:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:224
|
||
msgid "is written in **lower-case letters**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:225
|
||
msgid "is **relevant** to the media's content. (E.g., :file:`screenshot-tips.gif`.)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:226
|
||
msgid "separates its words with a **hyphen** ``-`` (E.g., :file:`awesome-filename.png`.)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:228
|
||
msgid "Each document has its own folder in which the media files are located. The folder's name must be the same as the document's filename."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:231
|
||
msgid "For example, the document :file:`doc_filename.rst` refers to two images that are placed in the folder ``doc_filename``."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:243
|
||
msgid "Previously, image filenames would mostly be named with numbers (e.g., :file:`feature01.png`) and placed in a single ``media`` folder. While it is advised not to name your *new* images in that fashion, it is also essential **not to rename unchanged files**, as doing this would double the weight of renamed image files on the repository. They will eventually all be replaced as the content referencing those images is updated."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:252
|
||
msgid "ALT tags"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:254
|
||
msgid "An **ALT tag** is a *text alternative* to an image. This text is displayed if the browser fails to render the image. It is also helpful for users who are visually impaired. Finally, it helps search engines, such as Google, to understand what the image is about and index it correctly, which improves the :abbr:`SEO (Search Engine Optimization)` significantly."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:259
|
||
msgid "Good ALT tags are:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:261
|
||
msgid "**Short** (one line maximum)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:262
|
||
msgid "**Not a repetition** of a previous sentence or title"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:263
|
||
msgid "A **good description** of the action happening on the image"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:264
|
||
msgid "Easily **understandable** if read aloud"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/content_guidelines.rst:267
|
||
msgid ":ref:`RST cheat sheet: image directive <contributing/image>`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:3
|
||
msgid "RST cheat sheet"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:8
|
||
msgid "Headings"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:11
|
||
msgid "For each formatting line (e.g., ``===``), write as many symbols (``=``) as there are characters in the header."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:15
|
||
msgid "The symbols used for the formatting are, in fact, not important. Only the order in which they are written matters, as it determines the size of the decorated heading. This means that you may encounter different heading formatting and in a different order, in which case you should follow the formatting in place in the document. In any other case, use the formatting shown below."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:18
|
||
msgid "Heading size"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:18
|
||
msgid "Formatting"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:20
|
||
msgid "H1"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
msgid "``=======``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
msgid "``Heading``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:24
|
||
msgid "H2"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:27
|
||
msgid "H3"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
msgid "``-------``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:30
|
||
msgid "H4"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
msgid "``~~~~~~~``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:33
|
||
msgid "H5"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
msgid "``*******``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:36
|
||
msgid "H6"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
msgid "``^^^^^^^``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:41
|
||
msgid "Each document must have **exactly one H1 heading**. No less, no more."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:46
|
||
msgid "Markup"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:51
|
||
msgid "Inline markup"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:53
|
||
msgid "Use the following markups to emphasize your text to your liking:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:56
|
||
msgid "\\*\\*Text\\*\\*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:56
|
||
msgid "**Text**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:58
|
||
msgid "\\*Text\\*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:58
|
||
msgid "*Text*"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:60
|
||
msgid "\\`Text\\`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:60
|
||
msgid "``Text``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:64
|
||
msgid ":ref:`contributing/specialized-directives`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:69
|
||
msgid "Bulleted list"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:85
|
||
msgid "Numbered list"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:100
|
||
msgid "Nested lists"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:112
|
||
msgid "Hyperlinks"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:117
|
||
msgid "Hyperlink references"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:119
|
||
msgid "Hyperlink references are links to a URL with a custom label. They follow this syntax: ```label <URL>`_``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:123
|
||
msgid "The URL can be a relative path to a file within the documentation."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:126
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:147
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:193
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:233
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:264
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:289
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:314
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:409
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:17
|
||
msgid "Example"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:128
|
||
msgid "This excerpt of :abbr:`RST (reStructuredText)`: ``For instance, `this is a hyperlink reference <https://odoo.com>`_.`` is rendered as follows in HTML: “For instance, `this is a hyperlink reference <https://odoo.com>`_.”"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:135
|
||
msgid "External hyperlink targets"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:137
|
||
msgid "External hyperlink targets allow creating shortcuts for hyperlink references."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:138
|
||
msgid "The definition syntax is as follows: ``.. _target: URL``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:139
|
||
msgid "There are two ways to reference them, depending on the use case:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:141
|
||
msgid "``target_`` creates a hyperlink with the target name as label and the URL as reference. Note that the ``_`` moved after the target!"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:143
|
||
msgid "```label <target_>`_`` does exactly what you expect: the label replaces the name of the target, and the target is replaced by the URL."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:150
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:196
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:236
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:267
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:292
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:317
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:353
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:374
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:393
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:412
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:431
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:450
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:469
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:490
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:509
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:530
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:570
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:613
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:690
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:786
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:876
|
||
msgid "RST"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:160
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:212
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:244
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:275
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:300
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:331
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:362
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:382
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:401
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:420
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:439
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:458
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:478
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:498
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:518
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:540
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:589
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:648
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:734
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:810
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:885
|
||
msgid "Render"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:162
|
||
msgid "A `proof-of-concept <https://en.wikipedia.org/wiki/Proof_of_concept>`_ is a simplified version, a prototype of what is expected to agree on the main lines of expected changes. `PoC <https://en.wikipedia.org/wiki/Proof_of_concept>`_ is a common abbreviation."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:169
|
||
msgid "Internal hyperlink targets"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:171
|
||
msgid "Internal hyperlink targets follow the same syntax as external hyperlink targets but without any URL. Indeed, they are internal. They allow referencing a specific part of a document by using the target as an anchor. When the user clicks on the reference, the documentation scrolls to the part of the page containing the target."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:177
|
||
msgid "Targets can be referenced from other files than the ones in which they are defined."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:179
|
||
msgid "The definition syntax is: ``.. _target:``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:180
|
||
msgid "There are two ways to reference them, both using the ``ref`` directive:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:182
|
||
msgid "``:ref:`target``` creates a hyperlink to the anchor with the heading defined below as label."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:183
|
||
msgid "``:ref:`label <target>``` creates a hyperlink to the anchor with the given label."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:185
|
||
msgid "See :ref:`contributing/relative-links` to learn how to write proper relative links for internal references."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:189
|
||
msgid "Notice that there is no ``_`` at the end, as it is done with :ref:`hyperlink targets <contributing/hyperlink-references>`."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:214
|
||
msgid "This can easily be done by creating a new product, see `How to create a product? <https://example.com/product>`_ for additional help."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:217
|
||
msgid "**How to create a product?**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:219
|
||
msgid "As explained at the `start of the page <https://example.com/scroll-to-start-of-page>`_, ..."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:224
|
||
msgid "Implicit hyperlink targets"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:228
|
||
msgid "Implicit hyperlink targets are a special kind of internal hyperlink targets: they are automatically generated by section titles, footnotes, etc. Consequently, they don’t have a definition syntax."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:230
|
||
msgid "They can be referenced the same first way as external hyperlink targets by using the name of the section title as URL."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:246
|
||
msgid "This can easily be done by creating a new user, see `How to create a new user? <https://example.com/how-to-create-a-user>`_ for additional help. ..."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:252
|
||
msgid "The ``doc`` directive"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:255
|
||
msgid "The ``doc`` directive allows referencing a documentation page wherever it is in the file tree through a relative file path."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:256
|
||
msgid "As usual, there are two ways to use the directive:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:258
|
||
msgid "``:doc:`path_to_doc_page``` creates a hyperlink reference to the documentation page with the title of the page as label."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:260
|
||
msgid "``:doc:`label <path_to_doc_page>``` creates a hyperlink reference to the documentation page with the given label."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:277
|
||
msgid "Please refer to `this documentation <https://example.com/doc/accounting/invoices.html>`_ and to `Send a pro-forma invoice <https://example.com/doc/sales/proforma.html>`_."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:283
|
||
msgid "The ``download`` directive"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:285
|
||
msgid "The ``download`` directive allows referencing files (that are not necessarily :abbr:`RST (reStructuredText)` documents) within the source tree to be downloaded."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:302
|
||
msgid "Download this `module structure template <https://example.com/doc/odoosh/extras/my_module.zip>`_ to start building your module in no time."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:308
|
||
msgid "The ``image`` directive"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:310
|
||
msgid "The ``image`` directive allows inserting images in a document. It comes with a set of optional parameter directives that can individually be omitted if considered redundant."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:345
|
||
msgid "Admonitions (alert blocks)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:350
|
||
msgid "Seealso"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:365
|
||
msgid "`Customer invoices <https://example.com/doc/accounting/invoices.html>`_"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:366
|
||
msgid "`Pro-forma invoices <https://example.com/doc/sales/proforma.html#activate-the-feature>`_"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:371
|
||
msgid "Note"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:385
|
||
msgid "Use this admonition to grab the reader's attention about additional information."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:390
|
||
msgid "Tip"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:404
|
||
msgid "Use this admonition to inform the reader about a useful trick that requires an action."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:423
|
||
msgid "Use this admonition to show an example."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:428
|
||
msgid "Exercise"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:442
|
||
msgid "Use this admonition to suggest an exercise to the reader."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:447
|
||
msgid "Important"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:461
|
||
msgid "Use this admonition to notify the reader about an important information."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:466
|
||
msgid "Warning"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:481
|
||
msgid "Use this admonition to require the reader to proceed with caution with what is described in the warning."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:487
|
||
msgid "Danger"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:501
|
||
msgid "Use this admonition to bring the reader's attention to a serious threat."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:506
|
||
msgid "Custom"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:520
|
||
msgid "Title"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:522
|
||
msgid "Customize this admonition with a **Title** of your choice."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:527
|
||
msgid "Code blocks"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:550
|
||
msgid "Content tabs"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:553
|
||
msgid "The `tabs` directive may not work well in some situations. In particular:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:555
|
||
msgid "The tabs' headers cannot be translated."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:556
|
||
msgid "A tab cannot contain :ref:`headings <contributing/headings>`."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:557
|
||
msgid "An :ref:`admonition <contributing/admonitions>` cannot contain tabs."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:558
|
||
msgid "A tab cannot contain :ref:`internal hyperlink targets <contributing/internal-hyperlink-targets>`."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:564
|
||
msgid "Basic tabs"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:566
|
||
msgid "Basic tabs are useful to split content into multiple options. The `tabs` directive is used to define a sequence of tabs. Each tab is then defined with the `tab` directive followed by a label."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:593
|
||
msgid "Odoo Online"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:595
|
||
msgid "Content dedicated to Odoo Online users."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:597
|
||
msgid "Odoo.sh"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:599
|
||
msgid "Alternative for Odoo.sh users."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:601
|
||
msgid "On-premise"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:603
|
||
msgid "Third version for On-premise users."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:608
|
||
msgid "Nested tabs"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:610
|
||
msgid "Tabs can be nested inside one another."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:652
|
||
msgid "Stars"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:656
|
||
msgid "The Sun"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:658
|
||
msgid "The closest star to us."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:660
|
||
msgid "Proxima Centauri"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:662
|
||
msgid "The second closest star to us."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:664
|
||
msgid "Polaris"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:666
|
||
msgid "The North Star."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:668
|
||
msgid "Moons"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:672
|
||
msgid "The Moon"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:674
|
||
msgid "Orbits the Earth."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:676
|
||
msgid "Titan"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:678
|
||
msgid "Orbits Jupiter."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:683
|
||
msgid "Group tabs"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:685
|
||
msgid "Group tabs are special tabs that synchronize based on a group label. The last selected group is remembered and automatically selected when the user returns on the page or visits another page with the tabs group. The `group-tab` directive is used to define group tabs."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:738
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:740
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:752
|
||
msgid "C++"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:746
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:748
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:767
|
||
msgid "Java"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:778
|
||
msgid "Code tabs"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:780
|
||
msgid "Code tabs are essentially :ref:`group tabs <contributing/tabs/group>` that treat the content as a :ref:`code block <contributing/code-blocks>`. The `code-tab` directive is used to define a code tab. Just as for the `code-block` directive, the language defines the syntax highlighting of the tab. If set, the label is used instead of the language for grouping tabs."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:834
|
||
msgid "Document metadata"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:836
|
||
msgid "Sphinx supports document-wide metadata directives that specify a behavior for the entire page."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:837
|
||
msgid "They must be placed between colons (`:`) at the top of the source file."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:840
|
||
msgid "**Metadata**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:840
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:919
|
||
msgid "**Purpose**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:842
|
||
msgid "`show-content`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:842
|
||
msgid "Make a toctree page accessible from the navigation menu."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:844
|
||
msgid "`show-toc`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:844
|
||
msgid "Show the table of content on a page that has the `show-content` metadata directive."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:847
|
||
msgid "`code-column`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
msgid "Show a dynamic side column that can be used to display interactive tutorials or code excerpts."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:0
|
||
msgid "For example, see :doc:`/applications/finance/accounting/getting_started/memento`."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:852
|
||
msgid "`hide-page-toc`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:852
|
||
msgid "Hide the \"On this page\" sidebar and use full page width for the content."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:854
|
||
msgid "`custom-css`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:854
|
||
msgid "Link CSS files (comma-separated) to the document."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:856
|
||
msgid "`custom-js`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:856
|
||
msgid "Link JS files (comma-separated) to the document."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:858
|
||
msgid "`classes`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:858
|
||
msgid "Assign the specified classes to the `<main/>` element of the document."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:860
|
||
msgid "`orphan`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:860
|
||
msgid "Suppress the need to include the document in a toctree."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:862
|
||
msgid "`nosearch`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:862
|
||
msgid "Exclude the document from search results."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:868
|
||
msgid "Formatting tips"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:873
|
||
msgid "Break the line but not the paragraph"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:888
|
||
msgid "First super long line that you break in two… here is rendered as a single line."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:889
|
||
msgid "Second line that follows a line break."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:894
|
||
msgid "Add comments"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:896
|
||
msgid "If you made a particular choice of writing or formatting that a future writer should be able to understand and take into account, consider writing a comment. Comments are blocks of text that do not count as a part of the documentation and that are used to pass a message to writers of the source code. They consist of a line starting with two dots and a space, followed by the comment."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:901
|
||
msgid "``.. For instance, this line will not be rendered in the documentation.``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:906
|
||
msgid "Use tables"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:908
|
||
msgid "Make use of `this convenient table generator <https://www.tablesgenerator.com/text_tables>`_ to build your tables. Then, copy-paste the generated formatting into your document."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:914
|
||
msgid "Spice up your writing with specialized directives"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:916
|
||
msgid "Use these additional directives to fine-tune your content:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:919
|
||
msgid "**Directive**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:919
|
||
msgid "**Example**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:921
|
||
msgid "**RST**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:921
|
||
msgid "**HTML**"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:923
|
||
msgid "``abbr``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:923
|
||
msgid "Self-defining abbreviations"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:923
|
||
msgid "``:abbr:`SO (Sales Order)```"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:923
|
||
msgid ":abbr:`SO (Sales Order)`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:925
|
||
msgid "``command``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:925
|
||
msgid "Highlight a command"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:925
|
||
msgid "``:command:`python example.py```"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:925
|
||
msgid ":command:`python example.py`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:927
|
||
msgid "``dfn``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:927
|
||
msgid "Define a term"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:927
|
||
msgid "``:dfn:`a definition for a new term```"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:927
|
||
msgid ":dfn:`a definition for a new term`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:929
|
||
msgid "``file``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:929
|
||
msgid "Indicate a file path"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:929
|
||
msgid "``:file:`~/odoo/odoo-bin```"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:929
|
||
msgid ":file:`~/odoo/odoo-bin`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:931
|
||
msgid "``menuselection``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:931
|
||
msgid "Guide a user through a sequence of menus"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:931
|
||
msgid "``:menuselection:`Sales --> Configuration --> Settings```"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:931
|
||
msgid ":menuselection:`Sales --> Configuration --> Settings`"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:937
|
||
msgid "Escape markup symbols (Advanced)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:939
|
||
msgid "Markup symbols escaped with backslashes (``\\``) are rendered normally. For instance, ``this \\*\\*line of text\\*\\* with \\*markup\\* symbols`` is rendered as “this \\*\\*line of text\\*\\* with \\*markup\\* symbols”."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_cheat_sheet.rst:943
|
||
msgid "When it comes to backticks (`````), which are used in many case such as :ref:`hyperlink references <contributing/hyperlink-references>`, using backslashes for escaping is no longer an option because the outer backticks interpret enclosed backslashes and thus prevent them from escaping inner backticks. For instance, ```\\`this formatting\\```` produces an ``[UNKNOWN NODE title_reference]`` error. Instead, `````this formatting````` should be used to produce the following result: ```this formatting```."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:3
|
||
msgid "RST guidelines"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:8
|
||
msgid "Use relative links for internal URLs"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:10
|
||
msgid "If you need to reference an internal documentation page or a file that is not sitting in the same directory as your current page, always make use of *relative file paths* rather than *absolute file paths*. An absolute file path indicates the location of the target from the root of its file tree. A relative file path makes use of smart notations (such as ``../`` git that redirects to the parent folder) to indicate the location of the target *relative* to that of the source document."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:19
|
||
msgid "Given the following source file tree:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:34
|
||
msgid "A reference to the rendered :file:`prices.html` and :file:`variants.html` could be made from :file:`import.rst` as follows:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:37
|
||
msgid "Absolute:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:39
|
||
msgid "``https://odoo.com/documentation/14.0/applications/sales/sales/products_prices/prices.html``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:40
|
||
msgid "``https://odoo.com/documentation/14.0/applications/sales/sales/products_prices/products/variants.html``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:42
|
||
msgid "Relative:"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:44
|
||
msgid "``../prices.html``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:45
|
||
msgid "``variants.html``"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:47
|
||
msgid "The relative links are clearly superior in terms of readability and stability: the references survive version updates, folder name changes and file tree restructurations."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:53
|
||
msgid "Start a new line before the 100th character"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:55
|
||
msgid "In RST, it is possible to break a line without forcing a line break on the rendered HTML. Make use of this feature to write **lines of maximum 100 characters**. A line break in a sentence results in an additional whitespace in HTML. That means that you do not need to leave a trailing whitespace at the end of a line to separate words."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:61
|
||
msgid "You can safely break a line around the separators (``-->``) of ``menuselection`` directives and anywhere in a hyperlink reference. For the ``doc``, ``ref`` and ``download`` directives, this is only true for the label part of the reference."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:66
|
||
msgid "Example: Line breaks within directive and inline markup"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:75
|
||
msgid "Be consistent with indentation"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:77
|
||
msgid "Use only spaces (never tabs)."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:79
|
||
msgid "Use as many spaces at the beginning of an indented line as needed to align it with the first character of the directive in the line above. This usually implies 3 spaces but you only need 2 for bulleted lists."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:84
|
||
msgid "Example: The first ``:`` is below the ``i`` (3 spaces)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:93
|
||
msgid "Example: The ``:titlesonly:`` and page references start below the ``t`` (3 spaces)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:104
|
||
msgid "Example: Continuation lines resume below the ``I``’s of “Invoice” (2 spaces)"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:114
|
||
msgid "Use the menuselection directive"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:116
|
||
msgid "Although chaining characters ``‣`` and menu names works fine to indicate a user which menus to click, it is best to use the ``menuselection`` directive (see :ref:`contributing/specialized-directives`) for the same result. Indeed, it renders the menus chain consistently with the rest of the documentation and would automatically adapt to the new graphic chart if we were to switch to a new one. This directive is used inline as follows: ``:menuselection:`Settings --> Products --> Variants```."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:126
|
||
msgid "Write resilient code"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:128
|
||
msgid "Prefer the use of ``#.`` in numbered lists instead of ``1.``, ``2.``, etc. This removes the risk of breaking the numbering when adding new elements to the list and is easier to maintain."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:130
|
||
msgid "Avoid using implicit hyperlink targets and prefer internal hyperlink targets instead. Referencing the implicit target ``How to print quotations?`` is more prone to break than a reference to the explicit target ``_print_quotation`` which never appears in the rendered HTML and is thus even less likely to be modified."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:138
|
||
msgid "Prefix hyperlink targets with application names"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:140
|
||
msgid "As hyperlink targets are visible from the entire documentation when referenced with the ``ref`` directive, it is recommended to prefix the target name with that of the related application. For instance, naming a target ``_amazon/form`` instead of ``_form`` avoids unwanted behaviors and makes the purpose of the target clear."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:148
|
||
msgid "Don’t break hyperlink targets"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:150
|
||
msgid "When refactoring (improving without adding new content) section headings or hyperlink targets, take care not to break any hyperlink reference to these targets or update them accordingly."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:156
|
||
msgid "Use single-underscore suffixes for hyperlink references"
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:161
|
||
msgid "Although using a double-underscore suffix works most of the time for classic hyperlink references, it is not recommended as double-underscores normally indicate an anonymous hyperlink reference. This is a special kind of hyperlink reference that makes use of nameless hyperlink targets consisting only of two underscore."
|
||
msgstr ""
|
||
|
||
#: ../../content/contributing/documentation/rst_guidelines.rst:163
|
||
msgid "tl;dr: Double-underscore suffixes work until they don’t and are bad practice, use single-underscore suffixes instead."
|
||
msgstr ""
|