Commit Graph

103 Commits

Author SHA1 Message Date
Hugo Locurcio
bebd5b86c4 Add color constants reference to BBCode in RichTextLabel
This reference is already present in the Color class reference,
but this embeds it directly in the page to save users a click.
2024-11-11 16:27:14 +01:00
Mikael
a362a0a7f2 Update "Size and anchors" to reflect Godot 4.3 terminology (#10216)
Changed relevant occurences of margin with "anchor offset" or "offset".

Also reworded paragraph about aspect ratios, as it included information that may not necessarily be correct.

Also replaced images with newer versions.
2024-11-09 00:08:04 +01:00
tetrapod00
5994348764 Change all usages of "run-time" to "runtime" 2024-11-06 23:36:58 -08:00
tetrapod00
a8667ffddf Add links to project setting mentions 2024-11-05 11:55:14 -08:00
Andrew Price
68a83880e5 Fix duplicate "glyph_spacing" in bbcode docs
The correct name for the space spacing option is space_spacing.
2024-09-21 13:10:38 +01:00
Max Hilbrunner
4361f19daf Merge pull request #9963 from ELginas/patch-2
Typo fix in bbcode_in_richtextlabel.rst
2024-09-17 00:21:33 +02:00
ELginas
7b9e7dfaed Remove unnecessary ` in bbcode_in_richtextlabel.rst 2024-09-16 18:03:22 +03:00
ELginas
2b34eb658c Typo fix in bbcode_in_richtextlabel.rst 2024-09-16 17:52:28 +03:00
Hugo Locurcio
709fe6aab2 Add variable font weight table to Using fonts 2024-08-01 03:17:07 +02:00
Hugo Locurcio
f039df956c Link to class reference BBCode syntax subset in BBCode in RichTextLabel 2024-07-14 21:15:43 +02:00
bruvzg
dd74ee5345 Sync BBCode tutorial page with features added in 4.3. 2024-06-14 11:51:43 +03:00
A Thousand Ships
bd6cc665a7 Fix incorrect uses of a/an 2024-03-29 15:14:27 +01:00
i'DLisT
fecc91f4b2 Update to newer CustomMinimumSize API 2024-02-08 23:20:19 +08:00
Yevhen Babiichuk (DustDFG)
6c7b0917bb Update gui_using_fonts.rst
Add link to *open-source* alternative of BMFont editor
2024-02-01 20:16:38 +02:00
Hugo Locurcio
95fb178429 Add support for user-provided comments with Giscus
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
2024-01-11 17:51:53 +01:00
Lulu
a0ce0dd4e3 Corrected closing in example for [lang] tag 2023-12-18 18:24:29 +01:00
Hugo Locurcio
f9817954c7 Remove unused images
This reduces the size of ZIP downloads for offline reading.

Unused images were found by running `_tools/list-unused-images.sh`.
These images were used in Godot 2.x and 3.x documentation,
but have been replaced by remade images with different names since.
2023-11-13 21:57:19 +01:00
Max Hilbrunner
2958e6d168 Merge pull request #8410 from Calinou/using-fonts-outline-shadow
Document setting up font outline, shadow and MSDF in Using fonts
2023-11-11 02:29:45 +01:00
Max Hilbrunner
455140b958 Merge pull request #8442 from Calinou/using-fonts-system-fonts-android-unreliable
Mark Android system font loading as unreliable in Using fonts
2023-11-10 22:26:59 +01:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Hugo Locurcio
fc911e7433 Mark Android system font loading as unreliable in Using fonts 2023-11-10 12:08:43 +01:00
Hugo Locurcio
7e802135d5 Document setting up font outline, shadow and MSDF in Using fonts
Screenshots were previously committed but were unused, as I previously
forgot to write these sections.
2023-11-07 18:06:28 +01:00
Matthew
d8a2cf9332 Merge pull request #8404 from ershn/patch-3
Replace `,` with `.` in `gui_containers.rst`
2023-11-06 22:03:11 -05:00
Steven Le Boëdec
06efb133b4 Replace , with . in gui_containers.rst 2023-11-07 11:06:03 +09:00
Steven Le Boëdec
edb966aecc Remove extra the in tutorials/ui/index.rst 2023-11-07 09:51:57 +09:00
Max Hilbrunner
c712afaafe Merge pull request #8363 from Calinou/add-runtime-file-loading-saving
Add a page on runtime file loading and saving
2023-11-05 00:08:50 +01:00
Brett Parker
f5d3d8ece8 Update bbcode_in_richtextlabel.rst - Typo
Both left and right aligned said righ-aligned #8367
2023-11-01 08:10:25 +00:00
Hugo Locurcio
3ebfc56843 Add a page on runtime file loading and saving
This accompanies a new demo project.
2023-10-31 09:43:50 +01:00
Hugo Locurcio
4724d6d737 Update BBCode in RichTextLabel documentation for Godot 4.2
- Add `lang` tag.
- Add `tab_stops` parameter to `p`.
- Add `pulse` built-in effect and remove custom pulse effect as it's
  superseded.
2023-10-28 02:03:10 +02:00
Paul Joannon
a60ab49aac Fix some forgotten lowercase x/y/z 2023-10-21 21:23:01 +02:00
Yogendra Manawat
291d3bcaae Added an overview of the containers subtypes (#7722)
* Added an overview of the containers subtypes

* converted all images to .webp format
2023-10-09 02:03:03 +02:00
Luna
0fe7ff833e Fixed typos in several doc files (#8002)
* Fixed typos in
- c_sharp_differences.rst
- debugger_panel.rst
- gdextension_cpp_example.rst
- gui_using_fonts.rst
- openxr_hand_tracking.rst
- overview_of_debugging_tools.rst
- setting_up_xr.rst
- shading_language.rst
- the_profiler.rst
- your_second_3d_shader.rst

* Update tutorials/shaders/shader_reference/shading_language.rst

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

* PR Feedback

---------

Co-authored-by: Luna <2650849-Lunalicious@users.noreply.gitlab.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-09-25 00:41:33 +02:00
Najo
a5fbd7f0e9 typo "rasterizd"
Fixed a typo by changing "rasterizd" to "rasterized"
2023-08-10 16:30:12 +02:00
bdan-codes
1e96a4c8dd fix typo in bbcode_in_richtextlabel.rst
fixes the "tornao" typo in bbcode_in_richtextlabel.rst (its supposed to be tornado)
2023-08-06 19:53:45 -04:00
Hugo Locurcio
9a3836396c Fix [img] resource type in BBCode in RichTextLabel 2023-07-21 04:40:58 +02:00
Max Hilbrunner
6d71eee28d Merge pull request #7552 from Calinou/richtextlabel-ul-bullet 2023-07-18 13:28:57 +02:00
Hugo Locurcio
df904137db Fix incorrect usage of backticks in various pages 2023-07-14 19:31:01 +02:00
Hugo Locurcio
81c997bf15 Document bullet parameter for ul tag in BBCode in RichTextLabel
This also adds `[shy]` (soft hyphen) to the list of control character
tags and clarifies which tags are self-closing.
2023-06-24 00:38:19 +02:00
Hugo Locurcio
28ebc5a792 Document whitespace handling in BBCode in RichTextLabel 2023-06-14 02:21:43 +02:00
Hugo Locurcio
20bfc52fd1 Document EMJC bitmap compression not being supported in Using fonts
- Document which system fonts are used on Android when using aliases.
- Mention font metrics varying across platforms when using system fonts.
- Fix notice about which platforms support system fonts.
2023-06-07 13:05:18 +02:00
Hugo Locurcio
d782a51bca Document disabling ligatures and/or kerning in Using fonts
This also mentions the `connected` parameter available in the
`tornado`, `wave`, `shake` built-in RichTextEffects.
2023-06-05 22:37:49 +02:00
Hugo Locurcio
6593354eaa Mention that all font sizes in Godot are in pixels, not points in Using fonts 2023-05-20 04:05:44 +02:00
Hugo Locurcio
cdc3f1f3ab Document font size caveats for pixel art fonts in Using fonts (#7355)
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-05-16 10:27:17 +02:00
Max Hilbrunner
7cc873c2dd Remove duplicate the-the 2023-04-18 03:02:23 +02:00
Silvio Mayolo
1269d592e1 Corrected virtual function name in "Custom GUI Controls" 2023-03-23 14:56:41 -04:00
Max Hilbrunner
29ead33bb3 Update mouse button enum references 2023-03-23 04:16:39 +01:00
Max Hilbrunner
e7ec0d54bc Merge pull request #6993 from Calinou/using-fonts-embolden
Document embolden and font spacing in Using fonts
2023-03-20 02:42:02 +01:00
Hugo Locurcio
38aea06740 Update and improve BBCode in RichTextlabel documentation for Godot 4.0
- Update screenshots for Godot 4.0.
- Document RichTextLabel having its own vertical scrollbar.
- Document `push_[tag]()` and `pop()` functions as a faster alternative
  to BBCode.
- Document threading support and when to use it.
- Document how to escape user input to prevent it from having its
  BBCode tags parsed.
- Document stripping BBCode tags from the text.
- Mention entangled tags not being supported.
- Mention faux bold/italic versus real bold/italic fonts.
- Document `[hint]` and `[dropcap]` BBCode tags.
- Mention animated RichTextEffects pausing when the scene tree is paused
  and how to control this behavior.
- Modify RichTextEffect examples to use the actual default values.
- Add screenshot showcasing how to add a RichTextEffect to the
  Custom Effects inspector property.
- Fix and improve `[pulse]` custom RichTextEffect. This adds an easing parameter
  and makes the target color a multiplier, so that colored text keeps its original
  color while fading in and out.
2023-03-19 21:11:55 +01:00
Hugo Locurcio
771b02a543 Document embolden and font spacing in Using fonts
This also mentions what the default project font is for reference.
2023-03-16 03:45:21 +01:00
Max Hilbrunner
f07b2313ae Merge pull request #6959 from pcamp/patch-5
Fix typos in gui_using_theme_editor
2023-03-13 01:05:39 +01:00