diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 138a24a..07495e3 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -81,13 +81,13 @@ Other namespaces must be written explicitly. Consult the widget library's documentation for a list of widgets. A good place to start is -`the Gtk4 widget list `. +`the Gtk4 widget list `_. Naming Widgets ~~~~~~~~~~~~~~ -Widgets can be given a **name/ID** so that they can be referenced by other -widgets in the blueprint. +Widgets can be given a **name/ID** so that they can be referenced by your +program or other widgets in the blueprint. .. code-block:: @@ -178,7 +178,7 @@ OR } Note the use of a semicolon at the end of the property in both cases. -Widget properties are not exempt of this rule. +Inline widget properties are not exempt of this rule. Property Bindings @@ -261,7 +261,7 @@ your language's bindings of Gtk. By default, signals in the blueprint will pass the widget that the signal is for as an argument to the *handler*. However, you can specify the -widget that is passed to the handler by referencing its **id** inside the +widget that is passed to the handler by referencing its **ID** inside the parenthesis. .. code-block:: @@ -278,11 +278,11 @@ parenthesis. Custom Widget Classes --------------------- -Some programs have custom widgets defined in their logic, and so blueprint +Some programs have custom widgets defined in their logic, so blueprint won't know that they exist. Writing widgets not defined in the GIR will result in an error. Prepend a custom widget with a ``.`` to prevent the -compiler from trying to validate the widget. This is essentially leaving -out the *namespace*. +compiler from trying to validate the widget. This is essentially saying +the widget has no *namespace*. To register a custom widget with the application consult the documentation for your language's bindings of Gtk. @@ -340,7 +340,7 @@ be used for any widget. Similarly to how every widget has styles, ] } -See `examples `_ for a list of more of these +See :doc:`examples ` for a list of more of these widget-specific items. @@ -348,7 +348,7 @@ Menus ----- Menus are usually the widgets that are placed along the top-bar of a -window, or pop up when you right-click some other widget. In Blueprint a +window, or pop up when you right-click some other widget. In Blueprint, a ``menu`` is a ``Gio.MenuModel`` that can be shown by MenuButtons or other widgets. @@ -410,7 +410,7 @@ Child Types ----------- Child types describe how a child widget is placed on a parent widget. For -example, HeaderBars widgets can have children placed either at the *start* +example, HeaderBar widgets can have children placed either at the *start* or the *end* of the Headerbar. Child widgets of HeaderBars can have the *start* or *end* types. Values for child types a widget can have are defined in the widget's documentation.