[gtk/ebassi/gidocgen: 4/465] docs: Add metadata preamble to GTK's content files
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/ebassi/gidocgen: 4/465] docs: Add metadata preamble to GTK's content files
- Date: Mon, 8 Mar 2021 22:25:58 +0000 (UTC)
commit b4ef48267b5bdb5ebb2f92287c78cfdec3569cbe
Author: Emmanuele Bassi <ebassi gnome org>
Date: Wed Feb 10 14:03:56 2021 +0000
docs: Add metadata preamble to GTK's content files
docs/reference/gtk/actions.md | 3 ++-
docs/reference/gtk/broadway.md | 9 ++++++---
docs/reference/gtk/building.md | 3 ++-
docs/reference/gtk/compiling.md | 3 ++-
docs/reference/gtk/css-overview.md | 3 ++-
docs/reference/gtk/css-properties.md | 3 ++-
docs/reference/gtk/drawing-model.md | 3 ++-
docs/reference/gtk/getting_started.md | 3 ++-
docs/reference/gtk/input-handling.md | 3 ++-
docs/reference/gtk/migrating-2to4.md | 3 ++-
docs/reference/gtk/migrating-3to4.md | 3 ++-
docs/reference/gtk/osx.md | 3 ++-
docs/reference/gtk/question_index.md | 3 ++-
docs/reference/gtk/resources.md | 3 ++-
docs/reference/gtk/running.md | 3 ++-
docs/reference/gtk/section-accessibility.md | 3 ++-
docs/reference/gtk/section-list-widget.md | 3 ++-
docs/reference/gtk/section-text-widget.md | 3 ++-
docs/reference/gtk/section-tree-widget.md | 3 ++-
docs/reference/gtk/wayland.md | 3 ++-
docs/reference/gtk/windows.md | 3 ++-
docs/reference/gtk/x11.md | 3 ++-
22 files changed, 48 insertions(+), 24 deletions(-)
---
diff --git a/docs/reference/gtk/actions.md b/docs/reference/gtk/actions.md
index 61433ccc19..51af4fbf3f 100644
--- a/docs/reference/gtk/actions.md
+++ b/docs/reference/gtk/actions.md
@@ -1,4 +1,5 @@
-# Overview of actions in GTK {#actions-overview}
+Title: Overview of actions in GTK
+Slug: actions
This chapter describes in detail how GTK uses actions to connect
activatable UI elements to callbacks. GTK inherits the underlying
diff --git a/docs/reference/gtk/broadway.md b/docs/reference/gtk/broadway.md
index 53d6d3d334..8bf24c43c1 100644
--- a/docs/reference/gtk/broadway.md
+++ b/docs/reference/gtk/broadway.md
@@ -1,4 +1,7 @@
-# Using GTK with Broadway {#gtk-broadway}
+Title: The Broadway windowing system
+Slug: broadway
+
+## Using GTK with Broadway
The GDK Broadway backend provides support for displaying GTK
applications in a web browser, using HTML5 and web sockets. To run
@@ -26,9 +29,9 @@ Start your applications like this:
GDK_BACKEND=broadway BROADWAY_DISPLAY=:5 gtk4-demo
```
-## Broadway-specific environment variables {#broadway-envar}
+## Broadway-specific environment variables
-### BROADWAY_DISPLAY
+### BROADWAY\_DISPLAY
Specifies the Broadway display number. The default display is 0.
The display number determines the port to use when connecting
diff --git a/docs/reference/gtk/building.md b/docs/reference/gtk/building.md
index 51c8802168..5e5a1d14bd 100644
--- a/docs/reference/gtk/building.md
+++ b/docs/reference/gtk/building.md
@@ -1,4 +1,5 @@
-# Compiling the GTK Libraries {#gtk-building}
+Title: Compiling the GTK Libraries
+Slug: gtk-building
## Building GTK
diff --git a/docs/reference/gtk/compiling.md b/docs/reference/gtk/compiling.md
index 1cceedded1..f73207d446 100644
--- a/docs/reference/gtk/compiling.md
+++ b/docs/reference/gtk/compiling.md
@@ -1,4 +1,5 @@
-# Compiling GTK Applications on UNIX {#gtk-compiling}
+Title: Compiling GTK Applications on UNIX
+Slug: gtk-compiling
To compile a GTK application, you need to tell the compiler where to
find the GTK header files and libraries. This is done with the
diff --git a/docs/reference/gtk/css-overview.md b/docs/reference/gtk/css-overview.md
index 0070c7e4f3..a9518dd428 100644
--- a/docs/reference/gtk/css-overview.md
+++ b/docs/reference/gtk/css-overview.md
@@ -1,4 +1,5 @@
-# CSS in GTK {#css}
+Title: CSS in GTK
+Slug: css
This chapter describes how GTK uses CSS for styling and layout.
It is not meant to be an explanation of CSS from first principles,
diff --git a/docs/reference/gtk/css-properties.md b/docs/reference/gtk/css-properties.md
index 8fa9819fc7..c08bfbf696 100644
--- a/docs/reference/gtk/css-properties.md
+++ b/docs/reference/gtk/css-properties.md
@@ -1,4 +1,5 @@
-# GTK CSS Properties
+Title: GTK CSS Properties
+Slug: css-properties
GTK supports CSS properties and shorthands as far as they can be applied
in the context of widgets, and adds its own properties only when needed.
diff --git a/docs/reference/gtk/drawing-model.md b/docs/reference/gtk/drawing-model.md
index fb3ad74690..6755894757 100644
--- a/docs/reference/gtk/drawing-model.md
+++ b/docs/reference/gtk/drawing-model.md
@@ -1,4 +1,5 @@
-# Overview of the drawing model {#drawing-overview}
+Title: Overview of the drawing model
+Slug: drawing-overview
This chapter describes the GTK drawing model in detail. If you
are interested in the procedure which GTK follows to draw its
diff --git a/docs/reference/gtk/getting_started.md b/docs/reference/gtk/getting_started.md
index 3196bef702..b10dd1e572 100644
--- a/docs/reference/gtk/getting_started.md
+++ b/docs/reference/gtk/getting_started.md
@@ -1,4 +1,5 @@
-# Getting Started with GTK {#gtk-getting-started}
+Title: Getting Started with GTK
+Slug: gtk-getting-started
GTK is a [widget toolkit](http://en.wikipedia.org/wiki/Widget_toolkit).
Each user interface created by GTK consists of widgets. This is implemented
diff --git a/docs/reference/gtk/input-handling.md b/docs/reference/gtk/input-handling.md
index 4685d51aa5..6186e7dbcb 100644
--- a/docs/reference/gtk/input-handling.md
+++ b/docs/reference/gtk/input-handling.md
@@ -1,4 +1,5 @@
-# Overview of GTK input and event handling {#input-overview}
+Title: Overview of GTK input and event handling
+Slug: input-overview
This chapter describes in detail how GTK handles input. If you are interested
in what happens to translate a key press or mouse motion of the users into a
diff --git a/docs/reference/gtk/migrating-2to4.md b/docs/reference/gtk/migrating-2to4.md
index dbfd941e23..da683e54e8 100644
--- a/docs/reference/gtk/migrating-2to4.md
+++ b/docs/reference/gtk/migrating-2to4.md
@@ -1,4 +1,5 @@
-# Migrating from GTK 2.x to GTK 4 {#gtk-migrating-2-to-4}
+Title: Migrating from GTK 2.x to GTK 4
+Slug: gtk-migrating-2-to-4
If your application is still using GTK 2, you should first convert it to GTK 3,
by following the [migration guide](https://developer.gnome.org/gtk3/stable/gtk-migrating-2-to-3.html)
diff --git a/docs/reference/gtk/migrating-3to4.md b/docs/reference/gtk/migrating-3to4.md
index c1670e4e2f..c40817967a 100644
--- a/docs/reference/gtk/migrating-3to4.md
+++ b/docs/reference/gtk/migrating-3to4.md
@@ -1,4 +1,5 @@
-# Migrating from GTK 3.x to GTK 4 {#gtk-migrating-3-to-4}
+Title: Migrating from GTK 3.x to GTK 4
+Slug: gtk-migrating-3-to-4
GTK 4 is a major new version of GTK that breaks both API and ABI
compared to GTK 3.x. Thankfully, most of the changes are not hard
diff --git a/docs/reference/gtk/osx.md b/docs/reference/gtk/osx.md
index 2ee5c02bb1..869c413f86 100644
--- a/docs/reference/gtk/osx.md
+++ b/docs/reference/gtk/osx.md
@@ -1,4 +1,5 @@
-# Using GTK on Apple macOS {#gtk-osx}
+Title: Using GTK on Apple macOS
+Slug: gtk-osx
The Apple macOS port of GTK is an implementation of GDK (and therefore GTK)
on top of the Quartz API.
diff --git a/docs/reference/gtk/question_index.md b/docs/reference/gtk/question_index.md
index 98e69881e6..505b20418d 100644
--- a/docs/reference/gtk/question_index.md
+++ b/docs/reference/gtk/question_index.md
@@ -1,4 +1,5 @@
-# Common Questions {#gtk-question-index}
+Title: Common Questions
+Slug: gtk-question-index
This is an "index" of the reference manual organized by common "How do
I..." questions. If you aren't sure which documentation to read for
diff --git a/docs/reference/gtk/resources.md b/docs/reference/gtk/resources.md
index c0683e8f76..93a295059c 100644
--- a/docs/reference/gtk/resources.md
+++ b/docs/reference/gtk/resources.md
@@ -1,4 +1,5 @@
-# Contact information and bug reports {#gtk-resources}
+Title: Contact information and bug reports
+Slug: gtk-resources
## Opening a bug or feature request
diff --git a/docs/reference/gtk/running.md b/docs/reference/gtk/running.md
index d294f8fc82..80e10e071c 100644
--- a/docs/reference/gtk/running.md
+++ b/docs/reference/gtk/running.md
@@ -1,4 +1,5 @@
-# Running and debugging GTK Applications {#gtk-running}
+Title: Running and debugging GTK Applications
+Slug: gtk-running
## Environment variables
diff --git a/docs/reference/gtk/section-accessibility.md b/docs/reference/gtk/section-accessibility.md
index b8145e0ad3..e785e8a935 100644
--- a/docs/reference/gtk/section-accessibility.md
+++ b/docs/reference/gtk/section-accessibility.md
@@ -1,4 +1,5 @@
-# GTK Accessibility {#gtk-accessibility}
+Title: GTK Accessibility
+Slug: gtk-accessibility
## The standard accessibility interface
diff --git a/docs/reference/gtk/section-list-widget.md b/docs/reference/gtk/section-list-widget.md
index b93ab872e3..0c24ff7c15 100644
--- a/docs/reference/gtk/section-list-widget.md
+++ b/docs/reference/gtk/section-list-widget.md
@@ -1,4 +1,5 @@
-# List Widget Overview {#ListWidget}
+Title: List Widget Overview
+Slug: gtk-list-widget
GTK provides powerful widgets to display and edit lists of data. This document
gives an overview over the concepts and how they work together to allow
diff --git a/docs/reference/gtk/section-text-widget.md b/docs/reference/gtk/section-text-widget.md
index 4184b88878..7eccd80680 100644
--- a/docs/reference/gtk/section-text-widget.md
+++ b/docs/reference/gtk/section-text-widget.md
@@ -1,4 +1,5 @@
-# Text Widget Overview {#TextWidget}
+Title: Text Widget Overview
+Slug: gtk-textview
GTK has an extremely powerful framework for multiline text editing. The
primary objects involved in the process are #GtkTextBuffer, which represents the
diff --git a/docs/reference/gtk/section-tree-widget.md b/docs/reference/gtk/section-tree-widget.md
index f30680be41..8db94e7d13 100644
--- a/docs/reference/gtk/section-tree-widget.md
+++ b/docs/reference/gtk/section-tree-widget.md
@@ -1,4 +1,5 @@
-# Tree and List Widget Overview {#TreeWidget}
+Title: Tree and List Widget Overview
+Slug: gtk-treeview
To create a tree or list in GTK, use the #GtkTreeModel interface in
conjunction with the #GtkTreeView widget. This widget is designed around
diff --git a/docs/reference/gtk/wayland.md b/docs/reference/gtk/wayland.md
index 0c99fc4952..f97bd10558 100644
--- a/docs/reference/gtk/wayland.md
+++ b/docs/reference/gtk/wayland.md
@@ -1,4 +1,5 @@
-# Using GTK with Wayland {#gtk-wayland}
+Title: Using GTK with Wayland
+Slug: gtk-wayland
The GDK Wayland backend provides support for running GTK applications
under a Wayland compositor. To run your application in this way, select
diff --git a/docs/reference/gtk/windows.md b/docs/reference/gtk/windows.md
index a5c14205e9..3541334d85 100644
--- a/docs/reference/gtk/windows.md
+++ b/docs/reference/gtk/windows.md
@@ -1,4 +1,5 @@
-# Using GTK on Windows {#gtk-windows}
+Title: Using GTK on Windows
+Slug: gtk-windows
The Windows port of GTK is an implementation of GDK (and therefore GTK)
on top of the Win32 API. When compiling GTK on Windows, this backend is
diff --git a/docs/reference/gtk/x11.md b/docs/reference/gtk/x11.md
index be2b74dc8e..063e5e2ea0 100644
--- a/docs/reference/gtk/x11.md
+++ b/docs/reference/gtk/x11.md
@@ -1,4 +1,5 @@
-# GTK for the X Window System {#gtk-x11}
+Title: GTK for the X Window System
+Slug: gtk-x11
On UNIX, the X backend is enabled by default, so you don't need to do anything
special when compiling it, and everything should "just work."
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]