Skip to content

Commit ef42566

Browse files
committed
doc: remove app_name
Removed app_name snippet from docs. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
1 parent 54c236f commit ef42566

File tree

7 files changed

+19
-20
lines changed

7 files changed

+19
-20
lines changed

doc/docs/creating_cluster_extension.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Creating a cluster extension
22

3-
This guide describes how to create a cluster extension and save it as an XML file using the {{app_name}}.
3+
This guide describes how to create a cluster extension and save it as an XML file using the Matter Cluster Editor app.
44

55
A cluster extension allows you to add new attributes, commands, events, enumerations, or structures to an existing Matter cluster without modifying the original cluster definition. This is useful when you need to extend standard Matter clusters with manufacturer-specific functionality.
66

77
{{matter_requirements}}
88
Make also sure that you have an existing cluster XML file that you want to extend, a clear understanding of what additional elements need to be added, and familiarity with the original cluster's structure and functionality.
99

1010
!!! note "Note"
11-
When adding new elements, make sure that the codes you assign do not conflict with existing elements in the original cluster. The {{app_name}} will help you identify conflicts when saving.
11+
When adding new elements, make sure that the codes you assign do not conflict with existing elements in the original cluster. The Matter Cluster Editor app will help you identify conflicts when saving.
1212

1313
To create a cluster extension, complete the following steps:
1414

@@ -30,4 +30,4 @@ To create a cluster extension, complete the following steps:
3030

3131
4. Click the **Save extension to file** button to save the cluster extension to a file.
3232

33-
The {{app_name}} validates that all required fields are filled before saving. If required fields are not filled or if there are no differences between the current cluster and the loaded cluster, you will see a [notification](overview.md#notifications).
33+
The Matter Cluster Editor app validates that all required fields are filled before saving. If required fields are not filled or if there are no differences between the current cluster and the loaded cluster, you will see a [notification](overview.md#notifications).

doc/docs/creating_device_type.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Creating a new device type
22

3-
This guide describes how to create a new device type and save it as an XML file using the {{app_name}}.
3+
This guide describes how to create a new device type and save it as an XML file using the Matter Cluster Editor app.
44

55
A device type defines the clusters, attributes, commands, and events that a specific type of Matter device supports. Creating a new device type allows you to define custom device functionality that isn't covered by the standard Matter Device Type Library specification.
66

@@ -33,4 +33,4 @@ To create a new device type, complete the following steps:
3333
6. Click the **Save extension to file** or **Save cluster type to file** button depending on the purpose of the file.<br/>
3434
See [Overview](overview.md#side-panel-sections) for more information about these buttons.
3535

36-
The {{app_name}} validates that all required fields are filled before saving. If required fields are not filled, you will see an [error message](overview.md#notifications).
36+
The Matter Cluster Editor app validates that all required fields are filled before saving. If required fields are not filled, you will see an [error message](overview.md#notifications).

doc/docs/creating_new_cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Creating a new Matter cluster
22

3-
This guide describes how to create a new Matter cluster and save it as an XML file using the {{app_name}}.
3+
This guide describes how to create a new Matter cluster and save it as an XML file using the Matter Cluster Editor app.
44

55
Creating a new Matter cluster involves defining the cluster's basic properties and adding the necessary elements (commands, attributes, events, enumerations, and structures) that make up the cluster's functionality.
66

@@ -23,4 +23,4 @@ To create a new cluster definition, complete the following steps:
2323
4. Click the **Save** button to save the cluster to a file.<br/>
2424
The cluster name should be unique across all available clusters in the Matter Data Model.
2525

26-
The {{app_name}} validates that all required fields are filled and saves the file. If there are any errors, you will see an [error message](overview.md#notifications).
26+
The Matter Cluster Editor app validates that all required fields are filled and saves the file. If there are any errors, you will see an [error message](overview.md#notifications).

doc/docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# {{app_name}}
1+
# Matter Cluster Editor app
22

3-
The {{app_name}} provides a graphical user interface for creating and editing Matter clusters, cluster extensions, and device types in accordance with the Matter Data Model. It is available as one of the applications in [nRF Connect for Desktop](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/index.html).
3+
The Matter Cluster Editor app provides a graphical user interface for creating and editing Matter clusters, cluster extensions, and device types in accordance with the Matter Data Model. It is available as one of the applications in [nRF Connect for Desktop](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/index.html).
44

55
To work with Matter using Nordic Semiconductor devices, read the [Matter protocol documentation in the {{NCS}}](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/index.html). For more information about the Matter Data Model, see the [Matter Data Model and device types](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/overview/data_model.html) page.
66

@@ -9,7 +9,7 @@ To work with Matter using Nordic Semiconductor devices, read the [Matter protoco
99
The Matter Data Model defines clusters that are common for all manufacturers and can be used as a base for devices.
1010
Sometimes, it is necessary to create a new cluster for a specific device, or extend an existing cluster to add new attributes, commands, or events that are specific to the device.
1111

12-
The {{app_name}} allows you to perform such operations using a graphical user interface.
12+
The Matter Cluster Editor app allows you to perform such operations using a graphical user interface.
1313
If the desired device type is not listed in the Matter Device Type Library specification, you can use the tool to create a new one, and include it in the project.
1414

1515
The app supports the following features:
@@ -25,11 +25,11 @@ You can use the XML file as an argument in the Matter west commands to add the X
2525

2626
## Installation
2727

28-
You can run the {{app_name}} when you [download and install nRF Connect for Desktop](https://www.nordicsemi.com/Products/Development-tools/nRF-Connect-for-Desktop/Download).
28+
You can run the Matter Cluster Editor app when you [download and install nRF Connect for Desktop](https://www.nordicsemi.com/Products/Development-tools/nRF-Connect-for-Desktop/Download).
2929

3030
## Supported devices
3131

32-
The {{app_name}} has no specific device requirements.
32+
The Matter Cluster Editor app has no specific device requirements.
3333

3434
## Application source code
3535

doc/docs/installing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Installing the {{app_name}}
1+
# Installing the Matter Cluster Editor app
22

33
For installation instructions, see [Installing nRF Connect for Desktop apps](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/installing_apps.html) in the nRF Connect for Desktop documentation.

doc/docs/overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Overview and user interface
22

3-
The {{app_name}} main window displays the basic information about the Matter cluster. The user interface broadly follows the organization of other nRF Connect for Desktop apps.
3+
The Matter Cluster Editor app main window displays the basic information about the Matter cluster. The user interface broadly follows the organization of other nRF Connect for Desktop apps.
44

5-
When you start the {{app_name}}, the application main window appears with the **Cluster** tab selected by default and its main panel empty.
5+
When you start the Matter Cluster Editor app, the application main window appears with the **Cluster** tab selected by default and its main panel empty.
66

7-
![{{app_name}} default view at startup](./screenshots/matter_cluster_tool_standard_view.png "{{app_name}} default view at startup")
7+
![Matter Cluster Editor app default view at startup](./screenshots/matter_cluster_tool_standard_view.png "Matter Cluster Editor app default view at startup")
88

99
!!! info "Tip"
1010
You can learn about tool functionalities directly from the tool interface by hovering your mouse over elements to see dedicated tooltips with information about each element.
@@ -39,7 +39,7 @@ The buttons in this section let you load Matter cluster XML files and save them.
3939

4040
This section includes the **Save extension to file** button, which checks the difference between the current filled-in values and the loaded cluster and saves the difference to an XML file.
4141

42-
The {{app_name}} automatically compares your current cluster with the originally loaded cluster and saves only the differences as an extension file. This means the following:
42+
The Matter Cluster Editor app automatically compares your current cluster with the originally loaded cluster and saves only the differences as an extension file. This means the following:
4343

4444
- Only newly added elements are included in the extension.
4545
- Modified elements are included with their new values.
@@ -532,13 +532,13 @@ You can edit the following fields of the feature entry.
532532

533533
Here you can view application information, restore settings to default, access source code, and documentation. You also can find information on the selected device, access support tools, and enable verbose logging.
534534

535-
![{{app_name}} About tab](./screenshots/matter_cluster_tool_about_tab.png "{{app_name}} About tab")
535+
![Matter Cluster Editor app About tab](./screenshots/matter_cluster_tool_about_tab.png "Matter Cluster Editor app About tab")
536536

537537
## Log
538538

539539
The Log panel allows you to view the most important log events, tagged with a timestamp.
540540

541-
Given that the {{app_name}} does not interact with any devices, it does not use the Log panel. For this reason, the panel is hidden by default (the **SHOW LOG** toggle is disabled).
541+
Given that the Matter Cluster Editor app does not interact with any devices, it does not use the Log panel. For this reason, the panel is hidden by default (the **SHOW LOG** toggle is disabled).
542542

543543
## Notifications
544544

doc/mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ plugins:
5353

5454
extra:
5555
test: This is a test abbreviation snippet
56-
app_name: Matter Cluster Editor app
5756
NCS: nRF Connect SDK
5857
matter_requirements: To take full advantage of this guide, you need to be familiar with the [Matter architecture](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/overview/architecture.html) and the [Matter Device Type Library specification](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/overview/data_model.html).
5958

0 commit comments

Comments
 (0)