godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

British to American spelling (#1837)

Browse Source 
* British to American spelling
This commit is contained in:
Joe Sweeney
2018-10-21 13:51:57 -06:00
committed by Max Hilbrunner
parent e46437632e
commit fe76bef199
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -12,7 +12,7 @@ Though arguably less convenient to edit than a wiki, this git repository is mean
### Editing existing pages
To edit an existing page, locate its .rst source file and open it in your favourite text editor. You can then commit the changes, push them to your fork and make a pull request. **Note that the pages in `classes/` should not be edited here, they are automatically generated from Godot's [XML class references](https://github.com/godotengine/godot/tree/master/doc/classes).**
To edit an existing page, locate its .rst source file and open it in your favorite text editor. You can then commit the changes, push them to your fork and make a pull request. **Note that the pages in `classes/` should not be edited here, they are automatically generated from Godot's [XML class references](https://github.com/godotengine/godot/tree/master/doc/classes).**
### Adding new pages
@@ -40,7 +40,7 @@ Similarly, you can include attachments (like assets as support material for a tu
## Building with Sphinx
To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](http://sphinx-doc.org/) >= 1.3 as well as (for the HTML) the [readthedocs.org theme](https://github.com/snide/sphinx_rtd_theme). Only the Python 3 flavour was tested, though the Python 2 versions might work too.
To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](http://sphinx-doc.org/) >= 1.3 as well as (for the HTML) the [readthedocs.org theme](https://github.com/snide/sphinx_rtd_theme). Only the Python 3 flavor was tested, though the Python 2 versions might work too.
Those tools are best installed using [pip](https://pip.pypa.io), Python's module installer. The Python 3 version might be provided (on Linux distros) as `pip3` or `python3-pip`. You can then run:
@@ -62,7 +62,7 @@ make SPHINXBUILD=~/.local/bin/sphinx-build html
```
The compilation might take some time as the `classes/` folder contains many files to parse.
You can then test the changes live by opening `_build/html/index.html` in your favourite browser.
You can then test the changes live by opening `_build/html/index.html` in your favorite browser.
### Building with Sphinx on Windows

8
getting_started/step_by_step/ui_introduction_to_the_ui_system.rst
View File

@@ -38,7 +38,7 @@ All control nodes share the same main properties:
1. Anchor
2. Bounding rectangle
3. Focus and focus neighbour
3. Focus and focus neighbor
4. Size flags
5. Margin
6. The optional UI theme
@@ -73,7 +73,7 @@ TextureRect
**TextureRect** displays a texture or image inside a UI.
It seems similar to the Sprite node but it offers multiple scaling modes.
Set the Stretch Mode property to change its behaviour:
Set the Stretch Mode property to change its behavior:
- ``Scale On Expand (compat)`` scales the texture to fit the node’s bounding rectangle, only if ``expand`` property is ``true``; otherwise, it behaves like ``Keep`` mode. Default mode for backwards compatibility.
- ``Scale`` scales the texture to fit the node’s bounding rectangle
@@ -84,7 +84,7 @@ Set the Stretch Mode property to change its behaviour:
- ``Keep Aspect`` and ``Keep Aspect Centered`` scales the texture but force it to remain its original aspect ratio, in the top left corner or the center of the frame respectively
- ``Keep Aspect Covered`` works just like ``Keep Aspect Centered`` but the shorter side fits the bounding rectangle and the other one clips to the node’s limits
As with Sprite nodes, you can modulate the TextureRect's colour. Click
As with Sprite nodes, you can modulate the TextureRect's color. Click
the ``Modulate`` property and use the color picker.
.. figure:: img/five_common_nodes_textureframe.png
@@ -156,7 +156,7 @@ NinePatchRect
**NinePatchRect** takes a texture split in 3 rows and 3 columns. The
center and the sides tile when you scale the texture, but it never
scales the corners. It is useful to build panels, dialogue boxes
scales the corners. It is useful to build panels, dialog boxes
and scalable backgrounds for your UI.
.. figure:: img/five_common_nodes_ninepatchrect.png