diff --git a/docs/docs/features/features.md b/docs/docs/features/features.md index 0b00529e..d167d6a2 100644 --- a/docs/docs/features/features.md +++ b/docs/docs/features/features.md @@ -12,7 +12,7 @@ This template generates code for [*Qt*](https://www.qt.io/) projects. In order t Basic understanding of *Qt* is required, and depending on your goal the qml or c++ knowledge is also necessary. ### Code generation -Follow the documentation for the [code generation](/docs/guide/intro) in general and [CLI](/docs/tools/cli/generate) or the [Studio](/docs/tools/studio/intro) tools. +Follow the documentation for the [code generation](/docs/guide/quick-start) in general and [CLI](/docs/cli/generate) or the [Studio](/docs/studio/intro) tools. Or try first the [quick start guide](../quickstart/index.md) which shows how to prepare api and generate code out of it. :::tip @@ -38,8 +38,8 @@ Features generate a view model for the `api`. This can be used to implement a wo ### Extended Features can be used in combination with `api` and add more functionality on top, like the simulation -- [olink](olink.md) - provides a client and server adapters for each interface, that can be connected to any of the other technology templates with support for [ObjectLink](/docs/advanced/protocols/objectlink/intro). Use this feature to connect with ApiGear simulation tools. -- [monitor](monitor.md) - generates a middleware layer which logs all API events to the [CLI](/docs/tools/cli/intro) or the [Studio](/docs/tools/studio/intro) +- [olink](olink.md) - provides a client and server adapters for each interface, that can be connected to any of the other technology templates with support for [ObjectLink](/docs/protocols/objectlink/intro). Use this feature to connect with ApiGear simulation tools. +- [monitor](monitor.md) - generates a middleware layer which logs all API events to the [CLI](/docs/cli/intro) or the [Studio](/docs/studio/intro) - [MQTT](mqtt.md) experimental - provides minimal working adapters for MQTT client and service side for each interfaces. Check also MQTT in other technology templates that supports it. - examples_olink - generates: - `olinkserver` example with `main.cpp` that shows your services in olink server. diff --git a/docs/docs/features/monitor.md b/docs/docs/features/monitor.md index a9c1e734..4208e881 100644 --- a/docs/docs/features/monitor.md +++ b/docs/docs/features/monitor.md @@ -6,8 +6,8 @@ import helloWorldModuleComponent from '!!raw-loader!./data/helloworld.module.yam # Monitor -Use our monitor feature to examine the interface calls, state and signals. With this feature you obtain a monitor client and a monitored version of your interfaces. The monitoring server is embedded into the [ApiGear Studio](/docs/tools/studio/intro) and CLI application(/docs/tools/cli/intro). -More details on [monitoring](/docs/advanced/monitor/intro) +Use our monitor feature to examine the interface calls, state and signals. With this feature you obtain a monitor client and a monitored version of your interfaces. The monitoring server is embedded into the [ApiGear Studio](/docs/studio/intro) and CLI application(/docs/cli/intro). +More details on [monitoring](/docs/monitor/intro) ## File overview for module diff --git a/docs/docs/features/olink.md b/docs/docs/features/olink.md index a3202073..da0ddaec 100644 --- a/docs/docs/features/olink.md +++ b/docs/docs/features/olink.md @@ -14,7 +14,7 @@ import Figure from '../figure' # Olink - This feature provides a *client* and a *server* adapter for your interfaces for the [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol. It allows you to connect different applications in the same or different technologies (check all of our [templates](/docs/sdk/intro)).
+ This feature provides a *client* and a *server* adapter for your interfaces for the [ObjectLink](/docs/protocols/objectlink/intro) protocol. It allows you to connect different applications in the same or different technologies (check all of our [templates](/docs/sdk/intro)).
Use an *OLink client* instead of your interface implementation to connect to a remote service, or to a the [ApiGear simulation](olink#simulation). Use an *OLink server adapter* to expose your interface implementation as a remote service.
Below you'll find short introduction on `ApiGear ObjectLink` protocol. Before details on client and server, you'll also find piece of information on a network layer implementation for handling ObjectLink in `Qt`. @@ -24,7 +24,7 @@ import Figure from '../figure' ::: ### Apigear ObjectLink protocol and ObjectLink core library -The [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol is a lightweight protocol for the Objects described with an interface. It allows connecting a client object with a server object, and perform remote operations like: remote property change request (client) or notifications on property changed (server), inform about signal emission (server) and allows requesting a call of a method (client) and giving a response to the outcome (server). +The [ObjectLink](/docs/protocols/objectlink/intro) protocol is a lightweight protocol for the Objects described with an interface. It allows connecting a client object with a server object, and perform remote operations like: remote property change request (client) or notifications on property changed (server), inform about signal emission (server) and allows requesting a call of a method (client) and giving a response to the outcome (server). The Olink feature for your interface uses a library [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp), common for cpp based templates. The provided CMakeLists already contain all the dependencies, so you don't have to add it manually. @@ -151,7 +151,7 @@ ApiGear::ObjectLink::ClientRegistry can have only one object of a certain type. ### Olink Server Adapter Files `📜olinkhelloadapter.h` and `📜olinkhelloadapter.h` contain the olink server adapter for the `Hello` interface - the `OLinkHelloAdapter` class.
-It implements an `IObjectSource` interface (from [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp)), which wraps your `Hello` and exposes it for remote usage with the [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol. It handles all the network requests, and calls your local object.
+It implements an `IObjectSource` interface (from [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp)), which wraps your `Hello` and exposes it for remote usage with the [ObjectLink](/docs/protocols/objectlink/intro) protocol. It handles all the network requests, and calls your local object.
When creating the `OLinkHelloAdapter` you need to provide the local `AbstractHello` service object, you want to expose to clients. The IObjectSource interface: @@ -243,11 +243,11 @@ ApplicationWindow { ## Simulation The simulation can be used to test, demonstrate or develop applications without the need to have the actual service available. - The simulation server is integrated into the [ApiGear studio](/docs/tools/studio/intro) and the [CLI](/docs/tools/cli/simulate). + The simulation server is integrated into the [ApiGear studio](/docs/studio/intro) and the [CLI](/docs/cli/simulate). - For simulating you will use [simulation scenarios](/docs/advanced/simulation/scenario) They allow to define sequences of actions. The actions can change the property values of the service or emit signals. The scenarios can be written using a YAML schema. + For simulating you will use [simulation scenarios](/docs/scripting/backends/scenario) They allow to define sequences of actions. The actions can change the property values of the service or emit signals. The scenarios can be written using a YAML schema. -See more on [simulation](/docs/advanced/simulation/intro). +See more on [simulation](/docs/scripting/backends/intro). ### Prepare your application Make sure you are using OlinkClient as your `Hello` object, either: diff --git a/docs/docs/quickstart/index.md b/docs/docs/quickstart/index.md index 9ad6b309..d8c00615 100644 --- a/docs/docs/quickstart/index.md +++ b/docs/docs/quickstart/index.md @@ -7,7 +7,7 @@ import QuickStartCommon from "@site/docs/_quickstart_common.md" The Quick-Start guide explains how to, in few steps, get from an API to a functional *Qt* plugin. Steps 1 and 3 are universal for other technologies. In the step 2 you will choose a concrete *Qt* template. -For more general information about first steps with ApiGear [First Steps](/docs/guide/intro) +For more general information about first steps with ApiGear [First Steps](/docs/guide/quick-start) The quick start enables only basic features: the [api](features/api.md) generation and simple [stub](features/stubs.md) implementation. For all available features check the [overview](features/features.md). @@ -53,7 +53,7 @@ For the pure virtual interface see the [pure C++ template](/template-cpp14/docs/ ::: :::note -For the simulation check [the olink feature](features/olink.md) which provides middle layer on your code side and the [simulation](/docs/advanced/simulation/intro) explained. +For the simulation check [the olink feature](features/olink.md) which provides middle layer on your code side and the [simulation](/docs/scripting/backends/intro) explained. ::: ### Create and run an example diff --git a/goldenmaster/README.md b/goldenmaster/README.md index 4879ae8c..1603c1c9 100644 --- a/goldenmaster/README.md +++ b/goldenmaster/README.md @@ -38,4 +38,4 @@ See https://apigear-io.github.io/template-qtcpp/ for more information For simulation the object link core protocol is used. Use the olink feature to prepare an olink client adapters and use it with your implementation of backend. (See olink client examples, set up proper server address). Use a simulation server to make single changes of an api manually or load simulation scenarios to feed your application automatically with desired behavior. -See https://docs.apigear.io/docs/advanced/simulation/intro +See https://docs.apigear.io/docs/scripting/backends/intro diff --git a/templates/README.md b/templates/README.md index 4879ae8c..1603c1c9 100644 --- a/templates/README.md +++ b/templates/README.md @@ -38,4 +38,4 @@ See https://apigear-io.github.io/template-qtcpp/ for more information For simulation the object link core protocol is used. Use the olink feature to prepare an olink client adapters and use it with your implementation of backend. (See olink client examples, set up proper server address). Use a simulation server to make single changes of an api manually or load simulation scenarios to feed your application automatically with desired behavior. -See https://docs.apigear.io/docs/advanced/simulation/intro +See https://docs.apigear.io/docs/scripting/backends/intro