Skip to content

Commit

Permalink
Fix path to dox example directories.
Browse files Browse the repository at this point in the history
  • Loading branch information
FabienLelaquais committed Sep 20, 2024
1 parent 3fde58e commit a415594
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
10 changes: 5 additions & 5 deletions docs/refmans/gui/viselements/generic/pane.md_template
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ detailed in the examples below:

# Usage

## Showing or hiding a pane {data-source="gui:doc/examples/blocks/pane-simple/"}
## Showing or hiding a pane {data-source="gui:doc/examples/blocks/pane_simple/"}

Here is a simple application that shows a page with a button that a user can click to open the
pane.
Expand Down Expand Up @@ -121,7 +121,7 @@ Here is how the page shows before and after the open button is pressed:

The pane closes when the user clicks on the original page area.

## Showing or hiding (simplified) {data-source="gui:doc/examples/blocks/pane-simple-lambda/"}
## Showing or hiding (simplified) {data-source="gui:doc/examples/blocks/pane_simple_lambda/"}

The previous section explains how to use the `on_action` callback to open the pane when a button is
pressed. Because the action is so simple (setting a variable to True), this can be simplified using
Expand Down Expand Up @@ -165,7 +165,7 @@ Here is an alternative page definition:
We set the *on_action* property of the button control to a lambda function that sets the variable
*show_pane* to true, so the definition of the callback function is no longer needed.

## Choosing where the pane appears {data-source="gui:doc/examples/blocks/pane-anchor/"}
## Choosing where the pane appears {data-source="gui:doc/examples/blocks/pane_anchor/"}

The [*anchor*](#p-anchor) property defines which side of the page the pane is shown on.

Expand Down Expand Up @@ -208,7 +208,7 @@ is visible:
<figcaption>Pane anchored to the top</figcaption>
</figure>

## Showing the pane beside the page content {data-source="gui:doc/examples/blocks/pane-persistent/"}
## Showing the pane beside the page content {data-source="gui:doc/examples/blocks/pane_persistent/"}

The pane is shown beside the page content instead of over it if the [*persistent*](#p-persistent)
property evaluates to True.
Expand Down Expand Up @@ -279,7 +279,7 @@ Here is how the page appears when the pane is opened or closed:
</figure>
</div>

## Pane from a page definition {data-source="gui:doc/examples/blocks/pane-as-page/"}
## Pane from a page definition {data-source="gui:doc/examples/blocks/pane_as_page/"}

The content of the pane can be specified as an existing page using the [*page*](#p-page) property,
which can be set to a page name. This can be useful when the pane content definition is complex or
Expand Down
12 changes: 5 additions & 7 deletions docs/refmans/gui/viselements/generic/progress.md_template
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ A control that can show the progression of some operation.

# Details

The progress indicator represents, in a compact way, the ratio of an achievement on a scale from 0
to 100 percent.<br/>
It is useful in situations where a lengthy process is underway, and the application needs to reflect
how much of the task has been completed at any given moment.

The progress indicator represents, in a compact way, the ratio of achievement on a scale from 0 to
100 percent.<br/>
It is useful in situations where a lengthy process is underway, and the application needs to reflect
Expand All @@ -23,6 +18,9 @@ to True.<br/>
The control can also display a title (using the [*title*](#p-title)) that can be displayed at
different locations, depending on the setting of the [*title_anchor*](#p-title_anchor) property.

Note that is the [*value*](#p-value) property is set to None, the progress control shows an
*indeterminate* state.

# Usage

## Circular progress indicator {data-source="gui:doc/examples/controls/progress-simple.py"}
Expand Down Expand Up @@ -94,7 +92,7 @@ class name to select the date selectors on your page and apply style.
Circular and linear progress indicators have slightly different implementations, impacting how
styling must be defined.

## Circular indicator {data-source="gui:doc/examples/controls/progress-styling-circular/"}
## Circular indicator {data-source="gui:doc/examples/controls/progress_styling_circular/"}

The implementation of the progress control is based on the
[MUI CircularProgress](https://mui.com/material-ui/react-progress/#circular) component.<br/>
Expand Down Expand Up @@ -124,7 +122,7 @@ Here is the impact of this rule:
</figure>
</div>

## Linear indicator {data-source="gui:doc/examples/controls/progress-styling-linear/"}
## Linear indicator {data-source="gui:doc/examples/controls/progress_styling_linear/"}

The linear version of the progress control relies on the
[MUI LinearProgress](https://mui.com/material-ui/react-progress/#linear) component.<br/>
Expand Down

0 comments on commit a415594

Please sign in to comment.