From f2372e12ce0d01bdd77f19382c9c54658dfafd53 Mon Sep 17 00:00:00 2001 From: hutcheb Date: Tue, 12 Nov 2024 16:50:56 +0800 Subject: [PATCH] fix(website): Fixed Edit Button, Page Attributes and Apache Links --- .../generate-config-documentation.groovy | 2 +- website/antora-playbook.yml | 2 +- website/asciidoc/antora.yml | 3 +- website/asciidoc/modules/apache/nav.adoc | 23 --- .../asciidoc/modules/apache/pages/index.adoc | 20 -- .../developers/pages/architecture.adoc | 2 +- .../modules/developers/pages/building.adoc | 8 +- .../developers/pages/code-gen/index.adoc | 16 +- .../pages/code-gen/language/freemarker.adoc | 2 +- .../pages/code-gen/protocol/df1.adoc | 2 +- .../pages/code-gen/protocol/mspec.adoc | 2 +- .../modules/developers/pages/conferences.adoc | 2 +- .../developers/pages/contributing.adoc | 4 +- .../modules/developers/pages/decisions.adoc | 2 +- .../modules/developers/pages/index.adoc | 2 +- .../developers/pages/infrastructure/ci.adoc | 2 +- .../pages/infrastructure/index.adoc | 2 +- .../pages/infrastructure/issues.adoc | 2 +- .../pages/infrastructure/sonar.adoc | 2 +- .../developers/pages/infrastructure/vm.adoc | 2 +- .../pages/infrastructure/website.adoc | 2 +- .../developers/pages/infrastructure/wiki.adoc | 2 +- .../modules/developers/pages/jqassistant.adoc | 2 +- .../modules/developers/pages/maturity.adoc | 2 +- .../developers/pages/preparing/index.adoc | 2 +- .../developers/pages/preparing/linux.adoc | 2 +- .../developers/pages/preparing/macos.adoc | 2 +- .../developers/pages/preparing/windows.adoc | 2 +- .../pages/protocols/ads/protocol.adoc | 2 +- .../pages/protocols/eip/protocol.adoc | 2 +- .../developers/pages/protocols/index.adoc | 2 +- .../developers/pages/release/build-tools.adoc | 52 ++--- .../developers/pages/release/index.adoc | 1 - .../developers/pages/release/release.adoc | 2 +- .../developers/pages/release/validation.adoc | 2 +- .../modules/developers/pages/team.adoc | 2 +- .../modules/developers/pages/tools.adoc | 2 +- .../developers/pages/tutorials/index.adoc | 1 - .../testing-serializers-and-parsers.adoc | 2 +- .../pages/tutorials/writing-driver.adoc | 2 +- .../modules/users/pages/adopters.adoc | 2 +- .../users/pages/blogs-videos-and-slides.adoc | 2 +- .../users/pages/commercial-support.adoc | 2 +- .../modules/users/pages/download.adoc | 2 +- .../getting-started/general-concepts.adoc | 2 +- .../users/pages/getting-started/index.adoc | 2 +- .../opcua-client-certificate.adoc | 2 +- .../users/pages/getting-started/plc4c.adoc | 1 - .../users/pages/getting-started/plc4cs.adoc | 1 - .../users/pages/getting-started/plc4go.adoc | 2 +- .../users/pages/getting-started/plc4j.adoc | 6 +- .../users/pages/getting-started/plc4py.adoc | 2 +- .../getting-started/using-snapshots.adoc | 2 +- .../pages/getting-started/virtual-modbus.adoc | 6 +- .../asciidoc/modules/users/pages/index.adoc | 2 +- .../modules/users/pages/industry40.adoc | 2 +- .../pages/integrations/apache-calcite.adoc | 2 +- .../pages/integrations/apache-camel.adoc | 2 +- .../pages/integrations/apache-edgent.adoc | 2 +- .../pages/integrations/apache-iotdb.adoc | 2 +- .../pages/integrations/apache-kafka.adoc | 2 +- .../users/pages/integrations/apache-nifi.adoc | 2 +- .../integrations/apache-streampipes.adoc | 2 +- .../pages/integrations/eclipse-ditto.adoc | 2 +- .../pages/integrations/eclipse-milo.adoc | 2 +- .../users/pages/integrations/index.adoc | 2 +- .../asciidoc/modules/users/pages/issues.adoc | 2 +- .../modules/users/pages/preparing-issues.adoc | 1 - .../modules/users/pages/protocols/ab-eth.adoc | 2 +- .../modules/users/pages/protocols/ads.adoc | 2 +- .../modules/users/pages/protocols/bacnet.adoc | 2 +- .../modules/users/pages/protocols/c-bus.adoc | 2 +- .../modules/users/pages/protocols/can.adoc | 2 +- .../users/pages/protocols/canopen.adoc | 2 +- .../modules/users/pages/protocols/ctrlx.adoc | 2 +- .../modules/users/pages/protocols/deltav.adoc | 2 +- .../modules/users/pages/protocols/df1.adoc | 2 +- .../modules/users/pages/protocols/eip.adoc | 2 +- .../users/pages/protocols/firmata.adoc | 2 +- .../users/pages/protocols/genericcan.adoc | 2 +- .../users/pages/protocols/iec-60870.adoc | 2 +- .../modules/users/pages/protocols/index.adoc | 2 +- .../users/pages/protocols/knxnetip.adoc | 2 +- .../modules/users/pages/protocols/logix.adoc | 2 +- .../modules/users/pages/protocols/modbus.adoc | 2 +- .../modules/users/pages/protocols/opcua.adoc | 2 +- .../users/pages/protocols/open-protocol.adoc | 2 +- .../modules/users/pages/protocols/plc4x.adoc | 2 +- .../users/pages/protocols/profinet.adoc | 2 +- .../modules/users/pages/protocols/s7.adoc | 2 +- .../users/pages/protocols/simulated.adoc | 2 +- .../modules/users/pages/protocols/umas.adoc | 2 +- .../modules/users/pages/security.adoc | 2 +- .../users/pages/tools/capture-replay.adoc | 6 +- .../users/pages/tools/connection-cache.adoc | 4 +- .../users/pages/tools/connection-pool.adoc | 2 +- .../modules/users/pages/tools/index.adoc | 1 - .../modules/users/pages/tools/opm.adoc | 2 +- .../modules/users/pages/tools/scraper.adoc | 4 +- .../modules/users/pages/tools/testing.adoc | 4 +- .../modules/users/pages/transports/can.adoc | 4 +- .../modules/users/pages/transports/index.adoc | 2 +- .../users/pages/transports/pcap-replay.adoc | 4 +- .../users/pages/transports/raw-socket.adoc | 4 +- .../users/pages/transports/serial.adoc | 4 +- .../users/pages/transports/socketcan.adoc | 4 +- .../modules/users/pages/transports/tcp.adoc | 4 +- .../modules/users/pages/transports/udp.adoc | 4 +- .../modules/users/partials/ab-eth.adoc | 2 +- .../asciidoc/modules/users/partials/ads.adoc | 2 +- .../modules/users/partials/bacnet-ip.adoc | 2 +- .../modules/users/partials/c-bus.adoc | 2 +- .../modules/users/partials/canopen.adoc | 2 +- .../asciidoc/modules/users/partials/eip.adoc | 2 +- .../modules/users/partials/firmata.adoc | 2 +- .../modules/users/partials/genericcan.adoc | 2 +- .../users/partials/iec-60870-5-104.adoc | 2 +- .../modules/users/partials/knxnet-ip.adoc | 2 +- .../modules/users/partials/logix.adoc | 2 +- .../modules/users/partials/modbus-ascii.adoc | 2 +- .../modules/users/partials/modbus-rtu.adoc | 2 +- .../modules/users/partials/modbus-tcp.adoc | 2 +- .../modules/users/partials/opcua.adoc | 2 +- .../modules/users/partials/open-protocol.adoc | 2 +- .../modules/users/partials/plc4x.adoc | 2 +- .../modules/users/partials/profinet.adoc | 2 +- .../asciidoc/modules/users/partials/s7.adoc | 2 +- .../modules/users/partials/simulated.adoc | 2 +- website/pom.xml | 190 +++++------------- website/resources/index.html | 16 +- .../supplemental/partials/header-content.hbs | 15 +- 131 files changed, 238 insertions(+), 377 deletions(-) delete mode 100644 website/asciidoc/modules/apache/nav.adoc delete mode 100644 website/asciidoc/modules/apache/pages/index.adoc diff --git a/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy b/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy index 29c28cc565b..cb78b4297fb 100644 --- a/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy +++ b/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy @@ -102,7 +102,7 @@ for (final def protocolCode in plcDriverManager.getProtocolCodes()) { "\n" + " org.apache.plc4x\n" + " " + moduleName + "\n" + - " {current-last-released-version}\n" + + " {page-component-version}\n" + "\n" + "----" if(driver.metadata.defaultTransportCode.isPresent()) { diff --git a/website/antora-playbook.yml b/website/antora-playbook.yml index 36c452963dd..ea0483f3207 100644 --- a/website/antora-playbook.yml +++ b/website/antora-playbook.yml @@ -22,7 +22,7 @@ content: sources: - url: ../.. branches: HEAD - start_path: website/target/asciidoc + start_path: website/asciidoc ui: bundle: url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable diff --git a/website/asciidoc/antora.yml b/website/asciidoc/antora.yml index 85554ade41e..a94aeae6476 100644 --- a/website/asciidoc/antora.yml +++ b/website/asciidoc/antora.yml @@ -17,11 +17,10 @@ # under the License. # name: plc4x -version: 'latest' +version: '0.13.0-SNAPSHOT' prerelease: True title: PLC4X nav: - modules/ROOT/nav.adoc - modules/users/nav.adoc - modules/developers/nav.adoc -- modules/apache/nav.adoc \ No newline at end of file diff --git a/website/asciidoc/modules/apache/nav.adoc b/website/asciidoc/modules/apache/nav.adoc deleted file mode 100644 index 5fc22e49e55..00000000000 --- a/website/asciidoc/modules/apache/nav.adoc +++ /dev/null @@ -1,23 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one or more -// contributor license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright ownership. -// The ASF licenses this file to You under the Apache License, Version 2.0 -// (the "License"); you may not use this file except in compliance with -// the License. You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// -* xref:index.adoc[Apache] -** https://www.apache.org/[Apache Software Foundation] -** https://www.apache.org/foundation/how-it-works.html[How Apache Works] -** https://www.apache.org/licenses/[License] -** https://www.apache.org/foundation/marks/pmcs.html#navigation[Privacy Policy] -** https://www.apache.org/foundation/sponsorship.html[Sponsor Apache] -** https://www.apache.org/foundation/thanks.html[Thanks] diff --git a/website/asciidoc/modules/apache/pages/index.adoc b/website/asciidoc/modules/apache/pages/index.adoc deleted file mode 100644 index 35e48fafb3e..00000000000 --- a/website/asciidoc/modules/apache/pages/index.adoc +++ /dev/null @@ -1,20 +0,0 @@ -// -// Licensed to the Apache Software Foundation (ASF) under one or more -// contributor license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright ownership. -// The ASF licenses this file to You under the Apache License, Version 2.0 -// (the "License"); you may not use this file except in compliance with -// the License. You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// -:imagesdir: ../images/ -:icons: font - -= Apache diff --git a/website/asciidoc/modules/developers/pages/architecture.adoc b/website/asciidoc/modules/developers/pages/architecture.adoc index 8cba5334c16..76bf768acf6 100644 --- a/website/asciidoc/modules/developers/pages/architecture.adoc +++ b/website/asciidoc/modules/developers/pages/architecture.adoc @@ -19,7 +19,7 @@ == Simple case -include::partial$pom.adoc[] + In this simple case, an application asks the DriverManager to forward a connection creation to the corresponding Driver implementation, which then creates both a Connection and a MessageCodec instance. The Connection is the logical link between the connection state and the MessageCodec. A MessageCodec uses a TransportInstance to communicate with the target device. diff --git a/website/asciidoc/modules/developers/pages/building.adoc b/website/asciidoc/modules/developers/pages/building.adoc index 60581d5ef31..2a70162c82a 100644 --- a/website/asciidoc/modules/developers/pages/building.adoc +++ b/website/asciidoc/modules/developers/pages/building.adoc @@ -17,8 +17,6 @@ = Building PLC4X -include::partial$pom.adoc[] - PLC4X is built with `Apache Maven` and we have tried to make the build as simple as possible. However PLC4X aims at providing means to communicate with PLCs of multiple vendors using a shared API but also in a variety of different languages. @@ -158,8 +156,8 @@ repositories { } dependencies { - implementation group: 'org.apache.plc4x', name: 'plc4j-api', version: '{current-last-released-version}' - implementation group: 'org.apache.plc4x', name: 'plc4j-driver-s7', version: '{current-last-released-version}' - implementation group: 'org.apache.plc4x', name: 'plc4j-connection-pool', version: '{current-last-released-version}' + implementation group: 'org.apache.plc4x', name: 'plc4j-api', version: '{page-component-version}' + implementation group: 'org.apache.plc4x', name: 'plc4j-driver-s7', version: '{page-component-version}' + implementation group: 'org.apache.plc4x', name: 'plc4j-connection-pool', version: '{page-component-version}' } ---- diff --git a/website/asciidoc/modules/developers/pages/code-gen/index.adoc b/website/asciidoc/modules/developers/pages/code-gen/index.adoc index 0936909d83e..996eb64927c 100644 --- a/website/asciidoc/modules/developers/pages/code-gen/index.adoc +++ b/website/asciidoc/modules/developers/pages/code-gen/index.adoc @@ -18,7 +18,7 @@ = Code Generation -include::partial$pom.adoc[] + As hand-writing code for a lot of drivers in multiple languages would be quite a nightmare, we have invested a very large amount of time into finding a way to automate this. @@ -199,7 +199,7 @@ Here's an example of a driver pom for building a `S7` driver for `java`: org.apache.plc4x.plugins plc4x-code-generation - {current-last-released-version} + {page-component-version} test-java-s7-driver @@ -231,13 +231,13 @@ Here's an example of a driver pom for building a `S7` driver for `java`: org.apache.plc4x.plugins plc4x-code-generation-driver-base-java - {current-last-released-version} + {page-component-version} org.apache.plc4x.plugins plc4x-code-generation-language-java - {current-last-released-version} + {page-component-version} provided @@ -245,7 +245,7 @@ Here's an example of a driver pom for building a `S7` driver for `java`: org.apache.plc4x.plugins plc4x-code-generation-protocol-s7 - {current-last-released-version} + {page-component-version} provided @@ -263,7 +263,7 @@ The dependency: org.apache.plc4x.plugins plc4x-code-generation-driver-base-java - {current-last-released-version} + {page-component-version} .... @@ -276,7 +276,7 @@ The definitions of both the `s7` protocol and `java` language are provided by th org.apache.plc4x.plugins plc4x-code-generation-language-java - {current-last-released-version} + {page-component-version} provided @@ -289,7 +289,7 @@ and: org.apache.plc4x.plugins plc4x-code-generation-protocol-s7 - {current-last-released-version} + {page-component-version} provided diff --git a/website/asciidoc/modules/developers/pages/code-gen/language/freemarker.adoc b/website/asciidoc/modules/developers/pages/code-gen/language/freemarker.adoc index 3c2bd4c7f73..227d04bde88 100644 --- a/website/asciidoc/modules/developers/pages/code-gen/language/freemarker.adoc +++ b/website/asciidoc/modules/developers/pages/code-gen/language/freemarker.adoc @@ -18,7 +18,7 @@ = Apache Freemarker -include::partial$pom.adoc[] + For the Freemarker language output we are using an unmodified version of https://freemarker.apache.org[Apache Freemarker] to generate output. diff --git a/website/asciidoc/modules/developers/pages/code-gen/protocol/df1.adoc b/website/asciidoc/modules/developers/pages/code-gen/protocol/df1.adoc index 5325d57173c..dcd214e4f94 100644 --- a/website/asciidoc/modules/developers/pages/code-gen/protocol/df1.adoc +++ b/website/asciidoc/modules/developers/pages/code-gen/protocol/df1.adoc @@ -17,7 +17,7 @@ = Example: DF1 MSpec -include::partial$pom.adoc[] + The DF1 protocol has three basic messages: a command message, acknowledge and not acknowledge. A `0x10` is used as delimiter to differentiate between the messages and parts of the command message. diff --git a/website/asciidoc/modules/developers/pages/code-gen/protocol/mspec.adoc b/website/asciidoc/modules/developers/pages/code-gen/protocol/mspec.adoc index b86617c68d4..303ea56cee7 100644 --- a/website/asciidoc/modules/developers/pages/code-gen/protocol/mspec.adoc +++ b/website/asciidoc/modules/developers/pages/code-gen/protocol/mspec.adoc @@ -18,7 +18,7 @@ = The MSpec format -include::partial$pom.adoc[] + The `MSpec` format (Message Specification) was a result of a brainstorming session after evaluating a lot of other options. diff --git a/website/asciidoc/modules/developers/pages/conferences.adoc b/website/asciidoc/modules/developers/pages/conferences.adoc index bc9cf65001f..4de6fddc936 100644 --- a/website/asciidoc/modules/developers/pages/conferences.adoc +++ b/website/asciidoc/modules/developers/pages/conferences.adoc @@ -17,7 +17,7 @@ = Conferences & Events -include::partial$pom.adoc[] + On this page we are listing options to attend talks and events around PLC4X. diff --git a/website/asciidoc/modules/developers/pages/contributing.adoc b/website/asciidoc/modules/developers/pages/contributing.adoc index 21969f2c72b..191571ef606 100644 --- a/website/asciidoc/modules/developers/pages/contributing.adoc +++ b/website/asciidoc/modules/developers/pages/contributing.adoc @@ -18,8 +18,6 @@ = Contributing -include::partial$pom.adoc[] - == Forms of contribution There are multiple forms in which you can become involved with the PLC4X project. @@ -138,7 +136,7 @@ The same model is used for a wide variety of other projects, so it should be pre - `release` contains the latest released state. - Development is performed on the `develop` branch. - Features are developed in Feature-Branches with a prefix `feature/` -- Each minor release has a corresponding release branch `rel/{current-last-released-version}` +- Each minor release has a corresponding release branch `rel/{page-component-version}` - A release branch is spawned from `develop` only - Bugfix releases don't have a dedicated release branch, they are just performed on the corresponding minor versions release branch diff --git a/website/asciidoc/modules/developers/pages/decisions.adoc b/website/asciidoc/modules/developers/pages/decisions.adoc index 209190c7b5e..327cd28bebb 100644 --- a/website/asciidoc/modules/developers/pages/decisions.adoc +++ b/website/asciidoc/modules/developers/pages/decisions.adoc @@ -18,7 +18,7 @@ = Decision Making -include::partial$pom.adoc[] + == Introduction diff --git a/website/asciidoc/modules/developers/pages/index.adoc b/website/asciidoc/modules/developers/pages/index.adoc index baa4cac931b..8b47ea65aa5 100644 --- a/website/asciidoc/modules/developers/pages/index.adoc +++ b/website/asciidoc/modules/developers/pages/index.adoc @@ -19,7 +19,7 @@ = Developer Section -include::partial$pom.adoc[] + This part of the Apache PLC4X dedicated to provide information to people wanting to build PLC4X and hopefully also start contributing to this awesome project. diff --git a/website/asciidoc/modules/developers/pages/infrastructure/ci.adoc b/website/asciidoc/modules/developers/pages/infrastructure/ci.adoc index 0e1d0453855..042a0cc7100 100644 --- a/website/asciidoc/modules/developers/pages/infrastructure/ci.adoc +++ b/website/asciidoc/modules/developers/pages/infrastructure/ci.adoc @@ -18,7 +18,7 @@ = Continuous Integration -include::partial$pom.adoc[] + We are currently using the following CI systems. diff --git a/website/asciidoc/modules/developers/pages/infrastructure/index.adoc b/website/asciidoc/modules/developers/pages/infrastructure/index.adoc index 91537c44b58..6dbe4f870f8 100644 --- a/website/asciidoc/modules/developers/pages/infrastructure/index.adoc +++ b/website/asciidoc/modules/developers/pages/infrastructure/index.adoc @@ -19,6 +19,6 @@ = Infrastructure -include::partial$pom.adoc[] + In this section you can find information on the services the Apache PLC4X project makes use of. diff --git a/website/asciidoc/modules/developers/pages/infrastructure/issues.adoc b/website/asciidoc/modules/developers/pages/infrastructure/issues.adoc index 8099ef9bd94..23bbf36fa84 100644 --- a/website/asciidoc/modules/developers/pages/infrastructure/issues.adoc +++ b/website/asciidoc/modules/developers/pages/infrastructure/issues.adoc @@ -17,7 +17,7 @@ = Bug & Issue Tracker -include::partial$pom.adoc[] + Our bug & issue tracker is Github-Issues. diff --git a/website/asciidoc/modules/developers/pages/infrastructure/sonar.adoc b/website/asciidoc/modules/developers/pages/infrastructure/sonar.adoc index 5067e2a3a26..b692383060e 100644 --- a/website/asciidoc/modules/developers/pages/infrastructure/sonar.adoc +++ b/website/asciidoc/modules/developers/pages/infrastructure/sonar.adoc @@ -17,7 +17,7 @@ = Code Analysis -include::partial$pom.adoc[] + We are using `SonarCloud` as the service for static code analysis. diff --git a/website/asciidoc/modules/developers/pages/infrastructure/vm.adoc b/website/asciidoc/modules/developers/pages/infrastructure/vm.adoc index 27f33851b03..d44fccf0956 100644 --- a/website/asciidoc/modules/developers/pages/infrastructure/vm.adoc +++ b/website/asciidoc/modules/developers/pages/infrastructure/vm.adoc @@ -17,7 +17,7 @@ = The PLC4X Project VM -include::partial$pom.adoc[] + As, especially for the raw socket functionality of PLC4X, our project had higher demands on the infrastructure as other projects. Apache Infra kindly provided us with a dedicated VM. diff --git a/website/asciidoc/modules/developers/pages/infrastructure/website.adoc b/website/asciidoc/modules/developers/pages/infrastructure/website.adoc index 32ce12ce3b0..510708c608b 100644 --- a/website/asciidoc/modules/developers/pages/infrastructure/website.adoc +++ b/website/asciidoc/modules/developers/pages/infrastructure/website.adoc @@ -17,7 +17,7 @@ = Generating the Website -include::partial$pom.adoc[] + We are currently using the normal `Maven` build to not only generate the project artifacts, but also the projects website. diff --git a/website/asciidoc/modules/developers/pages/infrastructure/wiki.adoc b/website/asciidoc/modules/developers/pages/infrastructure/wiki.adoc index eef7e1e5e94..c411941dbb5 100644 --- a/website/asciidoc/modules/developers/pages/infrastructure/wiki.adoc +++ b/website/asciidoc/modules/developers/pages/infrastructure/wiki.adoc @@ -17,7 +17,7 @@ = WIKI -include::partial$pom.adoc[] + We use Apache's Confluence instance as Wiki, however most information is generally managed on this website. diff --git a/website/asciidoc/modules/developers/pages/jqassistant.adoc b/website/asciidoc/modules/developers/pages/jqassistant.adoc index 59d555f9035..fc4c50655dd 100644 --- a/website/asciidoc/modules/developers/pages/jqassistant.adoc +++ b/website/asciidoc/modules/developers/pages/jqassistant.adoc @@ -18,7 +18,7 @@ = Using JQAssistant -include::partial$pom.adoc[] + In PLC4X we are using a tool called `https://jqassistant.org/[JQAssistant]` for enforcing quality assurance rules. diff --git a/website/asciidoc/modules/developers/pages/maturity.adoc b/website/asciidoc/modules/developers/pages/maturity.adoc index f181aeee6c7..a2324ff3761 100644 --- a/website/asciidoc/modules/developers/pages/maturity.adoc +++ b/website/asciidoc/modules/developers/pages/maturity.adoc @@ -19,7 +19,7 @@ = Apache Maturity Model Assessment for PLC4X -include::partial$pom.adoc[] + == Overview diff --git a/website/asciidoc/modules/developers/pages/preparing/index.adoc b/website/asciidoc/modules/developers/pages/preparing/index.adoc index 8295e5d1483..206cac0101a 100644 --- a/website/asciidoc/modules/developers/pages/preparing/index.adoc +++ b/website/asciidoc/modules/developers/pages/preparing/index.adoc @@ -17,7 +17,7 @@ = Preparing your Computer -include::partial$pom.adoc[] + Building a project like Apache PLC4X on multiple target operating-systems is quite a challenge, but I think we managed to make it as simple as possible. diff --git a/website/asciidoc/modules/developers/pages/preparing/linux.adoc b/website/asciidoc/modules/developers/pages/preparing/linux.adoc index d5e4da2d650..ef335818f7c 100644 --- a/website/asciidoc/modules/developers/pages/preparing/linux.adoc +++ b/website/asciidoc/modules/developers/pages/preparing/linux.adoc @@ -17,7 +17,7 @@ = Linux -include::partial$pom.adoc[] + As tracking down issues which result from missing or outdated third party tools such as compilers are always hard do diagnose, we have extended the build of PLC4X with a `prerequisiteCheck` that automatically checks if required tools are installed and if a required minimum version is available. diff --git a/website/asciidoc/modules/developers/pages/preparing/macos.adoc b/website/asciidoc/modules/developers/pages/preparing/macos.adoc index 312085ea108..a26c970f802 100644 --- a/website/asciidoc/modules/developers/pages/preparing/macos.adoc +++ b/website/asciidoc/modules/developers/pages/preparing/macos.adoc @@ -17,7 +17,7 @@ = Mac OS -include::partial$pom.adoc[] + As tracking down issues which result from missing or outdated third party tools such as compilers are always hard do diagnose, we have extended the build of PLC4X with a `prerequisiteCheck` that automatically checks if required tools are installed and if a required minimum version is available. diff --git a/website/asciidoc/modules/developers/pages/preparing/windows.adoc b/website/asciidoc/modules/developers/pages/preparing/windows.adoc index 3f39f26dd9d..c050f722d1e 100644 --- a/website/asciidoc/modules/developers/pages/preparing/windows.adoc +++ b/website/asciidoc/modules/developers/pages/preparing/windows.adoc @@ -17,7 +17,7 @@ = Windows -include::partial$pom.adoc[] + As tracking down issues which result from missing or outdated third party tools such as compilers are always hard do diagnose, we have extended the build of PLC4X with a `prerequisiteCheck` that automatically checks if required tools are installed and if a required minimum version is available. diff --git a/website/asciidoc/modules/developers/pages/protocols/ads/protocol.adoc b/website/asciidoc/modules/developers/pages/protocols/ads/protocol.adoc index ad60dd59794..7f56a83b64e 100644 --- a/website/asciidoc/modules/developers/pages/protocols/ads/protocol.adoc +++ b/website/asciidoc/modules/developers/pages/protocols/ads/protocol.adoc @@ -18,7 +18,7 @@ = Beckhoff ADS Protocol :page-role: home -include::partial$pom.adoc[] + // https://plantuml.com/de/activity-diagram-legacy // https://deepu.js.org/svg-seq-diagram/Reference_Guide.pdf diff --git a/website/asciidoc/modules/developers/pages/protocols/eip/protocol.adoc b/website/asciidoc/modules/developers/pages/protocols/eip/protocol.adoc index 9cd75c31f16..b47bb0d111f 100644 --- a/website/asciidoc/modules/developers/pages/protocols/eip/protocol.adoc +++ b/website/asciidoc/modules/developers/pages/protocols/eip/protocol.adoc @@ -18,7 +18,7 @@ = EIP Protocol :page-role: home -include::partial$pom.adoc[] + // https://plantuml.com/de/activity-diagram-legacy // https://deepu.js.org/svg-seq-diagram/Reference_Guide.pdf diff --git a/website/asciidoc/modules/developers/pages/protocols/index.adoc b/website/asciidoc/modules/developers/pages/protocols/index.adoc index 0eb8bde518b..82e731b809c 100644 --- a/website/asciidoc/modules/developers/pages/protocols/index.adoc +++ b/website/asciidoc/modules/developers/pages/protocols/index.adoc @@ -17,7 +17,7 @@ = Usage of protocols -include::partial$pom.adoc[] + == Currently documented are: diff --git a/website/asciidoc/modules/developers/pages/release/build-tools.adoc b/website/asciidoc/modules/developers/pages/release/build-tools.adoc index a81ec63e165..73ee4342da6 100644 --- a/website/asciidoc/modules/developers/pages/release/build-tools.adoc +++ b/website/asciidoc/modules/developers/pages/release/build-tools.adoc @@ -19,7 +19,7 @@ = Releasing PLC4X Build-Tools -include::partial$pom.adoc[] + In contrast to the main project, the `plc4x-build-tools` repository contains a loose collection of sub-projects. @@ -38,7 +38,7 @@ According to SemVer, we have: Major, Minor and Bugfix releases. For each new Major and Minor release we create a new branch at the beginning of a code-freeze phase. -So if currently the project version in develop is `{code-generation-full-version}-SNAPSHOT`, we create a branch `release/{code-generation-short-version}`. +So if currently the project version in develop is `{{page-component-version}}`, we create a branch `release/{code-generation-short-version}`. When creating the branch is exactly the moment in which the version in `develop` is incremented to the next minor version. @@ -50,7 +50,7 @@ This is the version the `develop` branch will be changed to. mvn release:branch -DbranchName=releases/code-generation/{minor-version} Per default the plugin suggests the next bugfix version as working version, however we want it to use the next minor version. -So in case of preparing the release branch for `{code-generation-full-version}` the command would be the following: +So in case of preparing the release branch for `{{page-component-version}}` the command would be the following: [subs="verbatim,attributes"] ---- @@ -130,7 +130,7 @@ After that, the following command will to all preparation steps for the release: In general the plugin will now ask you 3 questions: 1. The version we want to release as (It will suggest the version you get by omitting the `-SNAPSHOT` suffix, keep it as it is) -2. The name of the tag the release commit will be tagged with in the SCM (Name it `releases/code-generation/{release-version}` (`releases/code-generation/{code-generation-full-version}` in our case) +2. The name of the tag the release commit will be tagged with in the SCM (Name it `releases/code-generation/{release-version}` (`releases/code-generation/{{page-component-version}}` in our case) 3. The next development version (The version present in the pom after the release) (leave it as it is suggested by the plugin) Usually for 1 and 3 the defaults are just fine, make sure the tag name is correct as this usually is different. @@ -142,7 +142,7 @@ What the plugin now does, is automatically to execute the following operations: 1. Check we aren't referencing any `SNAPSHOT` dependencies. 2. Update all pom versions to the release version. 3. Run a build with all tests -4. Commit the changes (commit message: `[maven-release-plugin] prepare release releases/code-generation/{code-generation-full-version}`) +4. Commit the changes (commit message: `[maven-release-plugin] prepare release releases/code-generation/{{page-component-version}}`) 5. Push the commit 6. Tag the commit 7. Update all poms to the next development version. @@ -156,7 +156,7 @@ is in the correct state. Please select the release branch and verify the commit image::release-git-history.png[] -It is important that the commit with the message "[maven-release-plugin] prepare release releases/code-generation/{code-generation-full-version}" is tagged with the release tag (in this case releases/code-generation/{code-generation-full-version}) +It is important that the commit with the message "[maven-release-plugin] prepare release releases/code-generation/{{page-component-version}}" is tagged with the release tag (in this case releases/code-generation/{{page-component-version}}) If you check the commit itself, it should mainly consist of version updates like this: @@ -230,20 +230,20 @@ The directory structure of this directory is as follows: [subs="verbatim,attributes"] ---- ./KEYS - ./build-tools/code-generation/{code-generation-full-version} - ./build-tools/code-generation/{code-generation-full-version}/rc1 - ./build-tools/code-generation/{code-generation-full-version}/rc1/README - ./build-tools/code-generation/{code-generation-full-version}/rc1/RELEASE_NOTES - ./build-tools/code-generation/{code-generation-full-version}/rc1/apache-plc4x-code-generation-{code-generation-full-version}-source-release.zip - ./build-tools/code-generation/{code-generation-full-version}/rc1/apache-plc4x-code-generation-{code-generation-full-version}-source-release.zip.asc - ./build-tools/code-generation/{code-generation-full-version}/rc1/apache-plc4x-code-generation-{code-generation-full-version}-source-release.zip.sha512 + ./build-tools/code-generation/{{page-component-version}} + ./build-tools/code-generation/{{page-component-version}}/rc1 + ./build-tools/code-generation/{{page-component-version}}/rc1/README + ./build-tools/code-generation/{{page-component-version}}/rc1/RELEASE_NOTES + ./build-tools/code-generation/{{page-component-version}}/rc1/apache-plc4x-code-generation-{{page-component-version}}-source-release.zip + ./build-tools/code-generation/{{page-component-version}}/rc1/apache-plc4x-code-generation-{{page-component-version}}-source-release.zip.asc + ./build-tools/code-generation/{{page-component-version}}/rc1/apache-plc4x-code-generation-{{page-component-version}}-source-release.zip.sha512 ---- -I usually prepare exactly the same directory structure, starting with the {code-generation-full-version} locally and then just import everything using the following command: +I usually prepare exactly the same directory structure, starting with the {{page-component-version}} locally and then just import everything using the following command: [subs="verbatim,attributes"] ---- -svn import {code-generation-full-version} https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{code-generation-full-version} -m"Staging of rc1 of PLC4X Build-Tools (Code-Generation) {code-generation-full-version}" +svn import {{page-component-version}} https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{page-component-version}} -m"Staging of rc1 of PLC4X Build-Tools (Code-Generation) {{page-component-version}}" ---- The `KEYS` file contains the PGP public key which belongs to the private key used to sign the release artifacts. @@ -269,10 +269,10 @@ The following would be the one used to do our first TLP release: [subs="verbatim,attributes"] ---- E-Mail Topic: - [VOTE] Apache PLC4X Build-Tools Code-Generation {code-generation-full-version} RC1 + [VOTE] Apache PLC4X Build-Tools Code-Generation {{page-component-version}} RC1 Message: - Apache PLC4X Build-Tools Code-Generation {code-generation-full-version} has been staged under [2] + Apache PLC4X Build-Tools Code-Generation {{page-component-version}} has been staged under [2] and it’s time to vote on accepting it for release. All Maven artifacts are available under [1]. Voting will be open for 72hr. @@ -281,7 +281,7 @@ The following would be the one used to do our first TLP release: are required to pass. Repository: https://gitbox.apache.org/repos/asf/plc4x-build-tools.git - Release tag: releases/code-generation/{code-generation-full-version} + Release tag: releases/code-generation/{{page-component-version}} Hash for the release tag: {replacethiswiththerealgitcommittag} Per [3] "Before voting +1 PMC members are required to download @@ -297,7 +297,7 @@ The following would be the one used to do our first TLP release: [1] https://repository.apache.org/content/repositories/orgapacheplc4x-{somefourdigitnumber} - [2] https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{code-generation-full-version}/rc1/ + [2] https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{page-component-version}}/rc1/ [3] https://www.apache.org/dev/release/validation.html#approving-a-release [4] https://plc4x.apache.org/developers/release/validation.html ---- @@ -308,7 +308,7 @@ As it is sometimes to do the vote counting, if voting and discussions are going [subs="verbatim,attributes"] ---- E-Mail Topic: - [DISCUSS] Apache PLC4X Build-Tools Code-Generation {code-generation-full-version} RC1 + [DISCUSS] Apache PLC4X Build-Tools Code-Generation {{page-component-version}} RC1 Message: This is the discussion thread for the corresponding VOTE thread. @@ -329,7 +329,7 @@ After the 72-our minimum wait period is over, and we have fulfilled the requirem [subs="verbatim,attributes"] ---- E-Mail Topic: - [RESULT] [VOTE] Apache PLC4X Build-Tools Code-Generation {code-generation-full-version} RC1 + [RESULT] [VOTE] Apache PLC4X Build-Tools Code-Generation {{page-component-version}} RC1 Message: So, the vote passes with 3 +1 votes by PMC members and one +1 vote by a non PMC member. @@ -344,9 +344,9 @@ This is done by moving them inside the Apache SVN. [subs="verbatim,attributes"] ---- - svn move -m "Release Apache PLC4X {code-generation-full-version}" \ - https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{code-generation-full-version}/rc1 \ - https://dist.apache.org/repos/dist/release/plc4x/build-tools/code-generation/{code-generation-full-version} + svn move -m "Release Apache PLC4X {{page-component-version}}" \ + https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{page-component-version}}/rc1 \ + https://dist.apache.org/repos/dist/release/plc4x/build-tools/code-generation/{{page-component-version}} ---- This will make the release artifacts available and will trigger them being copied to mirror sites. @@ -381,14 +381,14 @@ This has to be done with git [subs="verbatim,attributes"] ---- git checkout release -git merge releases/code-generation/{code-generation-full-version} +git merge releases/code-generation/{{page-component-version}} ---- When there are conflicts it could help to use the `theirs` merge strategy, i.e., [subs="verbatim,attributes"] ---- -git merge -X theirs releases/code-generation/{code-generation-full-version} +git merge -X theirs releases/code-generation/{{page-component-version}} ---- Possibly a manual conflict resolution has to be done afterwards. After that, changes need to diff --git a/website/asciidoc/modules/developers/pages/release/index.adoc b/website/asciidoc/modules/developers/pages/release/index.adoc index 3c1405f0e39..c872985a37a 100644 --- a/website/asciidoc/modules/developers/pages/release/index.adoc +++ b/website/asciidoc/modules/developers/pages/release/index.adoc @@ -19,4 +19,3 @@ = Releasing and Validating Releases -include::partial$pom.adoc[] \ No newline at end of file diff --git a/website/asciidoc/modules/developers/pages/release/release.adoc b/website/asciidoc/modules/developers/pages/release/release.adoc index 00be3bdce3d..b63568edbd9 100644 --- a/website/asciidoc/modules/developers/pages/release/release.adoc +++ b/website/asciidoc/modules/developers/pages/release/release.adoc @@ -19,7 +19,7 @@ = Releasing PLC4X -include::partial$pom.adoc[] + == TL/DR diff --git a/website/asciidoc/modules/developers/pages/release/validation.adoc b/website/asciidoc/modules/developers/pages/release/validation.adoc index 959675f0a7b..a7272ec6744 100644 --- a/website/asciidoc/modules/developers/pages/release/validation.adoc +++ b/website/asciidoc/modules/developers/pages/release/validation.adoc @@ -19,7 +19,7 @@ = Validating a staged release -include::partial$pom.adoc[] + TIP: On MacOS and Linux the first 4 steps can be automated. For details please read the section about tooling after this chapter. diff --git a/website/asciidoc/modules/developers/pages/team.adoc b/website/asciidoc/modules/developers/pages/team.adoc index a0fc0823ed7..9bec5d4f182 100644 --- a/website/asciidoc/modules/developers/pages/team.adoc +++ b/website/asciidoc/modules/developers/pages/team.adoc @@ -19,7 +19,7 @@ = Team -include::partial$pom.adoc[] + Sorted by first name: diff --git a/website/asciidoc/modules/developers/pages/tools.adoc b/website/asciidoc/modules/developers/pages/tools.adoc index 638c4e6bb50..568e95c1155 100644 --- a/website/asciidoc/modules/developers/pages/tools.adoc +++ b/website/asciidoc/modules/developers/pages/tools.adoc @@ -19,7 +19,7 @@ = Tools -include::partial$pom.adoc[] + In order to be able to work on PLC4X some tools have kindly been made available to Apache PLC4X committers. diff --git a/website/asciidoc/modules/developers/pages/tutorials/index.adoc b/website/asciidoc/modules/developers/pages/tutorials/index.adoc index 686d67b5603..9d47fddcc6a 100644 --- a/website/asciidoc/modules/developers/pages/tutorials/index.adoc +++ b/website/asciidoc/modules/developers/pages/tutorials/index.adoc @@ -19,4 +19,3 @@ = Tutorials -include::partial$pom.adoc[] \ No newline at end of file diff --git a/website/asciidoc/modules/developers/pages/tutorials/testing-serializers-and-parsers.adoc b/website/asciidoc/modules/developers/pages/tutorials/testing-serializers-and-parsers.adoc index 377ce1a00d1..27254cb0923 100644 --- a/website/asciidoc/modules/developers/pages/tutorials/testing-serializers-and-parsers.adoc +++ b/website/asciidoc/modules/developers/pages/tutorials/testing-serializers-and-parsers.adoc @@ -18,7 +18,7 @@ = Testing Serializers and Parsers -include::partial$pom.adoc[] + Currently, the build generates the serializers and parsers from a provided `mspec` specification. diff --git a/website/asciidoc/modules/developers/pages/tutorials/writing-driver.adoc b/website/asciidoc/modules/developers/pages/tutorials/writing-driver.adoc index d43439c0eac..fee803305a5 100644 --- a/website/asciidoc/modules/developers/pages/tutorials/writing-driver.adoc +++ b/website/asciidoc/modules/developers/pages/tutorials/writing-driver.adoc @@ -18,7 +18,7 @@ = Basic Building Blocs of a Driver / Protocol -include::partial$pom.adoc[] + The general pipeline for a Protocol looks like the following: diff --git a/website/asciidoc/modules/users/pages/adopters.adoc b/website/asciidoc/modules/users/pages/adopters.adoc index 02ab5314d17..70baa8a0b29 100644 --- a/website/asciidoc/modules/users/pages/adopters.adoc +++ b/website/asciidoc/modules/users/pages/adopters.adoc @@ -19,7 +19,7 @@ = Companies using Apache PLC4X -include::partial$pom.adoc[] + image::users/toddy-loves-apache.png[width=200,float=left] diff --git a/website/asciidoc/modules/users/pages/blogs-videos-and-slides.adoc b/website/asciidoc/modules/users/pages/blogs-videos-and-slides.adoc index 9dc01112c18..e3c879bbf4e 100644 --- a/website/asciidoc/modules/users/pages/blogs-videos-and-slides.adoc +++ b/website/asciidoc/modules/users/pages/blogs-videos-and-slides.adoc @@ -17,7 +17,7 @@ = Blogs, Videos and Slides on Apache PLC4X -include::partial$pom.adoc[] + == Blog posts diff --git a/website/asciidoc/modules/users/pages/commercial-support.adoc b/website/asciidoc/modules/users/pages/commercial-support.adoc index 79fa5c47637..e047851c12f 100644 --- a/website/asciidoc/modules/users/pages/commercial-support.adoc +++ b/website/asciidoc/modules/users/pages/commercial-support.adoc @@ -19,7 +19,7 @@ = Commercial support offerings for Apache PLC4X -include::partial$pom.adoc[] + image::users/toddy-loves-apache.png[width=200,float=left] diff --git a/website/asciidoc/modules/users/pages/download.adoc b/website/asciidoc/modules/users/pages/download.adoc index 22ebf97a33c..dc68345dba8 100644 --- a/website/asciidoc/modules/users/pages/download.adoc +++ b/website/asciidoc/modules/users/pages/download.adoc @@ -17,7 +17,7 @@ = Download -include::partial$pom.adoc[] + Be sure to verify your downloads by these https://www.apache.org/info/verification[procedures] using these https://downloads.apache.org/plc4x/KEYS[KEYS] for any Apache release. diff --git a/website/asciidoc/modules/users/pages/getting-started/general-concepts.adoc b/website/asciidoc/modules/users/pages/getting-started/general-concepts.adoc index 555c7b4a7b2..40df5cedce4 100644 --- a/website/asciidoc/modules/users/pages/getting-started/general-concepts.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/general-concepts.adoc @@ -17,7 +17,7 @@ = General Concepts -include::partial$pom.adoc[] + On this page we'll give a short introduction to the most important concepts that will help you understand Apache PLC4X better. diff --git a/website/asciidoc/modules/users/pages/getting-started/index.adoc b/website/asciidoc/modules/users/pages/getting-started/index.adoc index f7bbf5a4cf9..e81ad6ca23f 100644 --- a/website/asciidoc/modules/users/pages/getting-started/index.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/index.adoc @@ -17,7 +17,7 @@ = Getting Started -include::partial$pom.adoc[] + Depending on the programming language, the usage will differ, therefore please go to the `Getting Started` version of the language of choice. diff --git a/website/asciidoc/modules/users/pages/getting-started/opcua-client-certificate.adoc b/website/asciidoc/modules/users/pages/getting-started/opcua-client-certificate.adoc index 31cf7ae260f..2eafcac89aa 100644 --- a/website/asciidoc/modules/users/pages/getting-started/opcua-client-certificate.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/opcua-client-certificate.adoc @@ -19,7 +19,7 @@ = OPC UA : Client certificate creation -include::partial$pom.adoc[] + Below tutorial will teach you how to create client certificate for use within production environments. This tutorial focuses on preparation of configuration. diff --git a/website/asciidoc/modules/users/pages/getting-started/plc4c.adoc b/website/asciidoc/modules/users/pages/getting-started/plc4c.adoc index 82dd95e628f..921ba2ee988 100644 --- a/website/asciidoc/modules/users/pages/getting-started/plc4c.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/plc4c.adoc @@ -17,4 +17,3 @@ = Getting Started with C -include::partial$pom.adoc[] \ No newline at end of file diff --git a/website/asciidoc/modules/users/pages/getting-started/plc4cs.adoc b/website/asciidoc/modules/users/pages/getting-started/plc4cs.adoc index 7c857c0477b..92a69c349bc 100644 --- a/website/asciidoc/modules/users/pages/getting-started/plc4cs.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/plc4cs.adoc @@ -17,4 +17,3 @@ = Getting Started with C# -include::partial$pom.adoc[] \ No newline at end of file diff --git a/website/asciidoc/modules/users/pages/getting-started/plc4go.adoc b/website/asciidoc/modules/users/pages/getting-started/plc4go.adoc index 65d980fb7f7..fe2f5542005 100644 --- a/website/asciidoc/modules/users/pages/getting-started/plc4go.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/plc4go.adoc @@ -17,7 +17,7 @@ = Getting Started with Go -include::partial$pom.adoc[] + == Initializing a dummy project diff --git a/website/asciidoc/modules/users/pages/getting-started/plc4j.adoc b/website/asciidoc/modules/users/pages/getting-started/plc4j.adoc index f03550fba9a..44cc01e7c9e 100644 --- a/website/asciidoc/modules/users/pages/getting-started/plc4j.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/plc4j.adoc @@ -17,7 +17,7 @@ = Getting Started with Java -include::partial$pom.adoc[] + == Using the PLC4J API directly @@ -29,7 +29,7 @@ When using Maven, all you need to do is add this dependency: org.apache.plc4x plc4j-api - {current-last-released-version} + {page-component-version} ---- @@ -43,7 +43,7 @@ For example in order to communicate with an `S7 device` using the `S7 Protocol`, org.apache.plc4x plc4j-driver-s7 - {current-last-released-version} + {page-component-version} runtime ---- diff --git a/website/asciidoc/modules/users/pages/getting-started/plc4py.adoc b/website/asciidoc/modules/users/pages/getting-started/plc4py.adoc index 015a11a3096..766c1e3116d 100644 --- a/website/asciidoc/modules/users/pages/getting-started/plc4py.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/plc4py.adoc @@ -17,7 +17,7 @@ = Getting Started with Python -include::partial$pom.adoc[] + == Using the PLC4PY API directly diff --git a/website/asciidoc/modules/users/pages/getting-started/using-snapshots.adoc b/website/asciidoc/modules/users/pages/getting-started/using-snapshots.adoc index e1054520c1a..d2028f0e9a8 100644 --- a/website/asciidoc/modules/users/pages/getting-started/using-snapshots.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/using-snapshots.adoc @@ -17,7 +17,7 @@ = Using SNAPSHOT versions -include::partial$pom.adoc[] + Especially when it comes to trying to verify if an issue you are facing has already been fixed in the development version, you might want to or be asked to try out the absolute latest version of PLC4X. You can generally do this by adding "-SNAPSHOT" to the version number of PLC4X. diff --git a/website/asciidoc/modules/users/pages/getting-started/virtual-modbus.adoc b/website/asciidoc/modules/users/pages/getting-started/virtual-modbus.adoc index aade1905c90..f31532eb320 100644 --- a/website/asciidoc/modules/users/pages/getting-started/virtual-modbus.adoc +++ b/website/asciidoc/modules/users/pages/getting-started/virtual-modbus.adoc @@ -18,7 +18,7 @@ = Virtual Modbus PLC -include::partial$pom.adoc[] + If you want to get started with Apache PLC4X, but don't have any PLC at hand, this tutorial will demonstrate how you can use a virtual `Modbus Slave` software to simulate communication with `Modbus` enabled PLCs. @@ -157,7 +157,7 @@ When using Maven, all you need to do is add this dependency: org.apache.plc4x plc4j-api - {current-last-released-version} + {page-component-version} ---- @@ -171,7 +171,7 @@ For example in order to communicate using the `Modbus` protocol, you would need org.apache.plc4x plc4j-driver-modbus - {current-last-released-version} + {page-component-version} runtime ---- diff --git a/website/asciidoc/modules/users/pages/index.adoc b/website/asciidoc/modules/users/pages/index.adoc index ff933061e91..4820b43a183 100644 --- a/website/asciidoc/modules/users/pages/index.adoc +++ b/website/asciidoc/modules/users/pages/index.adoc @@ -19,7 +19,7 @@ = Users -include::partial$pom.adoc[] + This part of the PLC4X website is dedicated to people wanting to use Apache PLC4X. diff --git a/website/asciidoc/modules/users/pages/industry40.adoc b/website/asciidoc/modules/users/pages/industry40.adoc index b70cc504661..2f0d3eefa5b 100644 --- a/website/asciidoc/modules/users/pages/industry40.adoc +++ b/website/asciidoc/modules/users/pages/industry40.adoc @@ -17,7 +17,7 @@ = Industry 4.0 with Apache -include::partial$pom.adoc[] + Since the introduction of programmable logic controllers in the production industry in the early 80s, they have been the core of almost every piece of production machinery. diff --git a/website/asciidoc/modules/users/pages/integrations/apache-calcite.adoc b/website/asciidoc/modules/users/pages/integrations/apache-calcite.adoc index 331cf479121..60bcf069fe6 100644 --- a/website/asciidoc/modules/users/pages/integrations/apache-calcite.adoc +++ b/website/asciidoc/modules/users/pages/integrations/apache-calcite.adoc @@ -19,7 +19,7 @@ = Apache Calcite -include::partial$pom.adoc[] + https://calcite.apache.org/[Apache Calcite] Standard SQL diff --git a/website/asciidoc/modules/users/pages/integrations/apache-camel.adoc b/website/asciidoc/modules/users/pages/integrations/apache-camel.adoc index 6f09843a7b1..81f2e562471 100644 --- a/website/asciidoc/modules/users/pages/integrations/apache-camel.adoc +++ b/website/asciidoc/modules/users/pages/integrations/apache-camel.adoc @@ -19,7 +19,7 @@ = Apache Camel -include::partial$pom.adoc[] + The Camel Component for PLC4X allows you to create routes using the PLC4X API to read from a PLC device or write to it. This component is now maintained within the https://camel.apache.org/components/next/plc4x-component.html[Apache Camel] Project. diff --git a/website/asciidoc/modules/users/pages/integrations/apache-edgent.adoc b/website/asciidoc/modules/users/pages/integrations/apache-edgent.adoc index 899e510331e..3ea209559ae 100644 --- a/website/asciidoc/modules/users/pages/integrations/apache-edgent.adoc +++ b/website/asciidoc/modules/users/pages/integrations/apache-edgent.adoc @@ -19,4 +19,4 @@ = Apache Edgent (Retired) -include::partial$pom.adoc[] + diff --git a/website/asciidoc/modules/users/pages/integrations/apache-iotdb.adoc b/website/asciidoc/modules/users/pages/integrations/apache-iotdb.adoc index 9c9147c57f6..9955f917b22 100644 --- a/website/asciidoc/modules/users/pages/integrations/apache-iotdb.adoc +++ b/website/asciidoc/modules/users/pages/integrations/apache-iotdb.adoc @@ -19,7 +19,7 @@ = Apache IotDB -include::partial$pom.adoc[] + Apache IoTDB is database for storing time serie data. Therefore, it can be a good solution for managing the data which is collected by PLC4x. diff --git a/website/asciidoc/modules/users/pages/integrations/apache-kafka.adoc b/website/asciidoc/modules/users/pages/integrations/apache-kafka.adoc index 26112aff867..dbdc1a34596 100644 --- a/website/asciidoc/modules/users/pages/integrations/apache-kafka.adoc +++ b/website/asciidoc/modules/users/pages/integrations/apache-kafka.adoc @@ -19,7 +19,7 @@ = Apache Kafka -include::partial$pom.adoc[] + Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and diff --git a/website/asciidoc/modules/users/pages/integrations/apache-nifi.adoc b/website/asciidoc/modules/users/pages/integrations/apache-nifi.adoc index 64a7c2809a8..cf347d5cfc0 100644 --- a/website/asciidoc/modules/users/pages/integrations/apache-nifi.adoc +++ b/website/asciidoc/modules/users/pages/integrations/apache-nifi.adoc @@ -19,7 +19,7 @@ = Apache NiFi -include::partial$pom.adoc[] + Apache NiFi allows creating systems that process data around the concept of data-streams. diff --git a/website/asciidoc/modules/users/pages/integrations/apache-streampipes.adoc b/website/asciidoc/modules/users/pages/integrations/apache-streampipes.adoc index 25ff11dc97f..86ceb646d3b 100644 --- a/website/asciidoc/modules/users/pages/integrations/apache-streampipes.adoc +++ b/website/asciidoc/modules/users/pages/integrations/apache-streampipes.adoc @@ -19,7 +19,7 @@ = Apache StreamPipes -include::partial$pom.adoc[] + https://streampipes.apache.org/docs/pe/org.apache.streampipes.connect.iiot.adapters.plc4x.s7[PLC4X S7 Adapter,opts=nofollow] diff --git a/website/asciidoc/modules/users/pages/integrations/eclipse-ditto.adoc b/website/asciidoc/modules/users/pages/integrations/eclipse-ditto.adoc index e734f069a99..4c42cff54f2 100644 --- a/website/asciidoc/modules/users/pages/integrations/eclipse-ditto.adoc +++ b/website/asciidoc/modules/users/pages/integrations/eclipse-ditto.adoc @@ -19,7 +19,7 @@ = Eclipse Ditto -include::partial$pom.adoc[] + … where IoT devices and their digital twins get together diff --git a/website/asciidoc/modules/users/pages/integrations/eclipse-milo.adoc b/website/asciidoc/modules/users/pages/integrations/eclipse-milo.adoc index 4b1953bc5d4..6b7d3a40964 100644 --- a/website/asciidoc/modules/users/pages/integrations/eclipse-milo.adoc +++ b/website/asciidoc/modules/users/pages/integrations/eclipse-milo.adoc @@ -17,7 +17,7 @@ = Eclipse Milo (OPC UA Server) -include::partial$pom.adoc[] + The PLC4X OPC UA server integration is based around the Eclipse Milo OPC UA server. It uses PLC4X to communicate with industrial devices effectively acting as a industrial OPC UA gateway. diff --git a/website/asciidoc/modules/users/pages/integrations/index.adoc b/website/asciidoc/modules/users/pages/integrations/index.adoc index aca120a571c..2862236b003 100644 --- a/website/asciidoc/modules/users/pages/integrations/index.adoc +++ b/website/asciidoc/modules/users/pages/integrations/index.adoc @@ -19,4 +19,4 @@ = Integrations -include::partial$pom.adoc[] + diff --git a/website/asciidoc/modules/users/pages/issues.adoc b/website/asciidoc/modules/users/pages/issues.adoc index 8099ef9bd94..23bbf36fa84 100644 --- a/website/asciidoc/modules/users/pages/issues.adoc +++ b/website/asciidoc/modules/users/pages/issues.adoc @@ -17,7 +17,7 @@ = Bug & Issue Tracker -include::partial$pom.adoc[] + Our bug & issue tracker is Github-Issues. diff --git a/website/asciidoc/modules/users/pages/preparing-issues.adoc b/website/asciidoc/modules/users/pages/preparing-issues.adoc index 2972320bb7b..e94365f7f8f 100644 --- a/website/asciidoc/modules/users/pages/preparing-issues.adoc +++ b/website/asciidoc/modules/users/pages/preparing-issues.adoc @@ -17,4 +17,3 @@ = Preparing Issues & Bug Reports -include::partial$pom.adoc[] \ No newline at end of file diff --git a/website/asciidoc/modules/users/pages/protocols/ab-eth.adoc b/website/asciidoc/modules/users/pages/protocols/ab-eth.adoc index fd74d231c01..f827964da0e 100644 --- a/website/asciidoc/modules/users/pages/protocols/ab-eth.adoc +++ b/website/asciidoc/modules/users/pages/protocols/ab-eth.adoc @@ -19,7 +19,7 @@ = AB-ETH -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/ads.adoc b/website/asciidoc/modules/users/pages/protocols/ads.adoc index 912f9cc78d5..dc44c954161 100644 --- a/website/asciidoc/modules/users/pages/protocols/ads.adoc +++ b/website/asciidoc/modules/users/pages/protocols/ads.adoc @@ -21,7 +21,7 @@ image::users/protocols/ads_banner.png[banner,512,167] -include::partial$pom.adoc[] + diff --git a/website/asciidoc/modules/users/pages/protocols/bacnet.adoc b/website/asciidoc/modules/users/pages/protocols/bacnet.adoc index 48df17ec385..7ddc96d2dca 100644 --- a/website/asciidoc/modules/users/pages/protocols/bacnet.adoc +++ b/website/asciidoc/modules/users/pages/protocols/bacnet.adoc @@ -21,7 +21,7 @@ image::users/protocols/bacnet_banner.png[banner,512,167] -include::partial$pom.adoc[] + diff --git a/website/asciidoc/modules/users/pages/protocols/c-bus.adoc b/website/asciidoc/modules/users/pages/protocols/c-bus.adoc index 803f6a652c7..11c13e1ecac 100644 --- a/website/asciidoc/modules/users/pages/protocols/c-bus.adoc +++ b/website/asciidoc/modules/users/pages/protocols/c-bus.adoc @@ -19,7 +19,7 @@ = C-Bus -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/can.adoc b/website/asciidoc/modules/users/pages/protocols/can.adoc index 99054ad0262..96c8d785f40 100644 --- a/website/asciidoc/modules/users/pages/protocols/can.adoc +++ b/website/asciidoc/modules/users/pages/protocols/can.adoc @@ -21,7 +21,7 @@ image::users/protocols/can_banner.png[banner,512,167] -include::partial$pom.adoc[] + The CAN Bus driver is a special kind of driver which does not bring any logic. Its responsibility is to combine link:../transports/can.html[CAN transport facade] and custom application layer protocols. diff --git a/website/asciidoc/modules/users/pages/protocols/canopen.adoc b/website/asciidoc/modules/users/pages/protocols/canopen.adoc index a5539dbb9e9..771cbedbbcf 100644 --- a/website/asciidoc/modules/users/pages/protocols/canopen.adoc +++ b/website/asciidoc/modules/users/pages/protocols/canopen.adoc @@ -21,7 +21,7 @@ image::users/protocols/can_banner.png[banner,512,167] -include::partial$pom.adoc[] + diff --git a/website/asciidoc/modules/users/pages/protocols/ctrlx.adoc b/website/asciidoc/modules/users/pages/protocols/ctrlx.adoc index 32ac630050c..91bce84da50 100644 --- a/website/asciidoc/modules/users/pages/protocols/ctrlx.adoc +++ b/website/asciidoc/modules/users/pages/protocols/ctrlx.adoc @@ -19,7 +19,7 @@ = CtlrX -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/deltav.adoc b/website/asciidoc/modules/users/pages/protocols/deltav.adoc index d7b44001d70..3aed797ff31 100644 --- a/website/asciidoc/modules/users/pages/protocols/deltav.adoc +++ b/website/asciidoc/modules/users/pages/protocols/deltav.adoc @@ -19,4 +19,4 @@ = DeltaV -include::partial$pom.adoc[] + diff --git a/website/asciidoc/modules/users/pages/protocols/df1.adoc b/website/asciidoc/modules/users/pages/protocols/df1.adoc index ab0c1b49652..9784f49ffa0 100644 --- a/website/asciidoc/modules/users/pages/protocols/df1.adoc +++ b/website/asciidoc/modules/users/pages/protocols/df1.adoc @@ -19,4 +19,4 @@ = DF1 -include::partial$pom.adoc[] + diff --git a/website/asciidoc/modules/users/pages/protocols/eip.adoc b/website/asciidoc/modules/users/pages/protocols/eip.adoc index 2a195c2da8b..b0a9eef4b68 100644 --- a/website/asciidoc/modules/users/pages/protocols/eip.adoc +++ b/website/asciidoc/modules/users/pages/protocols/eip.adoc @@ -19,7 +19,7 @@ = EtherNet/IP -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/firmata.adoc b/website/asciidoc/modules/users/pages/protocols/firmata.adoc index 3952c9987d4..2e29f572de8 100644 --- a/website/asciidoc/modules/users/pages/protocols/firmata.adoc +++ b/website/asciidoc/modules/users/pages/protocols/firmata.adoc @@ -19,7 +19,7 @@ = Firmata -include::partial$pom.adoc[] + The Firmata protocol is based on the MIDI protocol used for communicating with musical equipment. diff --git a/website/asciidoc/modules/users/pages/protocols/genericcan.adoc b/website/asciidoc/modules/users/pages/protocols/genericcan.adoc index 0bf69a4c1c6..976b7816d30 100644 --- a/website/asciidoc/modules/users/pages/protocols/genericcan.adoc +++ b/website/asciidoc/modules/users/pages/protocols/genericcan.adoc @@ -19,7 +19,7 @@ = Generic CAN -include::partial$pom.adoc[] + == CAN Bus semantics diff --git a/website/asciidoc/modules/users/pages/protocols/iec-60870.adoc b/website/asciidoc/modules/users/pages/protocols/iec-60870.adoc index 0c2908e7707..a9fed39c5fb 100644 --- a/website/asciidoc/modules/users/pages/protocols/iec-60870.adoc +++ b/website/asciidoc/modules/users/pages/protocols/iec-60870.adoc @@ -19,7 +19,7 @@ = IEC-60870 -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/index.adoc b/website/asciidoc/modules/users/pages/protocols/index.adoc index a28b5d5d386..089393ecdcf 100644 --- a/website/asciidoc/modules/users/pages/protocols/index.adoc +++ b/website/asciidoc/modules/users/pages/protocols/index.adoc @@ -18,7 +18,7 @@ = Current language support for protocols -include::partial$pom.adoc[] + |=== |Protocol | C | C# | Go | Java | Python diff --git a/website/asciidoc/modules/users/pages/protocols/knxnetip.adoc b/website/asciidoc/modules/users/pages/protocols/knxnetip.adoc index 04db30dc811..444b7e8cc03 100644 --- a/website/asciidoc/modules/users/pages/protocols/knxnetip.adoc +++ b/website/asciidoc/modules/users/pages/protocols/knxnetip.adoc @@ -21,7 +21,7 @@ image::users/protocols/knx_banner.png[banner,512,167] -include::partial$pom.adoc[] + diff --git a/website/asciidoc/modules/users/pages/protocols/logix.adoc b/website/asciidoc/modules/users/pages/protocols/logix.adoc index 269c9e82905..aee5cb13cf9 100644 --- a/website/asciidoc/modules/users/pages/protocols/logix.adoc +++ b/website/asciidoc/modules/users/pages/protocols/logix.adoc @@ -19,7 +19,7 @@ = Logix -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/modbus.adoc b/website/asciidoc/modules/users/pages/protocols/modbus.adoc index 29a2cbf17f8..092895d0b28 100644 --- a/website/asciidoc/modules/users/pages/protocols/modbus.adoc +++ b/website/asciidoc/modules/users/pages/protocols/modbus.adoc @@ -19,7 +19,7 @@ = Modbus (TCP/UDP/Serial) -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/opcua.adoc b/website/asciidoc/modules/users/pages/protocols/opcua.adoc index 1a769d0d83a..d7c0b56961d 100644 --- a/website/asciidoc/modules/users/pages/protocols/opcua.adoc +++ b/website/asciidoc/modules/users/pages/protocols/opcua.adoc @@ -19,7 +19,7 @@ = OPC UA -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/open-protocol.adoc b/website/asciidoc/modules/users/pages/protocols/open-protocol.adoc index 58aa921e000..dff9aec0e14 100644 --- a/website/asciidoc/modules/users/pages/protocols/open-protocol.adoc +++ b/website/asciidoc/modules/users/pages/protocols/open-protocol.adoc @@ -19,7 +19,7 @@ = Open-Protocol (Torque-Tools) -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/plc4x.adoc b/website/asciidoc/modules/users/pages/protocols/plc4x.adoc index db34d5897f9..c27a1bb5ee6 100644 --- a/website/asciidoc/modules/users/pages/protocols/plc4x.adoc +++ b/website/asciidoc/modules/users/pages/protocols/plc4x.adoc @@ -19,7 +19,7 @@ = PLC4X (Proxy) (TCP) -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/profinet.adoc b/website/asciidoc/modules/users/pages/protocols/profinet.adoc index 7e88fe10dd6..e88ce97e48d 100644 --- a/website/asciidoc/modules/users/pages/protocols/profinet.adoc +++ b/website/asciidoc/modules/users/pages/protocols/profinet.adoc @@ -19,7 +19,7 @@ = Profinet (In Development) -include::partial$pom.adoc[] + The PROFINET driver implements a class 3 real time controller. Which is able to communicate with multiple devices on the same network segment. diff --git a/website/asciidoc/modules/users/pages/protocols/s7.adoc b/website/asciidoc/modules/users/pages/protocols/s7.adoc index df1288d782d..43532785380 100644 --- a/website/asciidoc/modules/users/pages/protocols/s7.adoc +++ b/website/asciidoc/modules/users/pages/protocols/s7.adoc @@ -25,7 +25,7 @@ image::users/protocols/s7_banner.png[banner,512,167] -include::partial$pom.adoc[] + == Executive Summary diff --git a/website/asciidoc/modules/users/pages/protocols/simulated.adoc b/website/asciidoc/modules/users/pages/protocols/simulated.adoc index 9375792988a..ed4a024141d 100644 --- a/website/asciidoc/modules/users/pages/protocols/simulated.adoc +++ b/website/asciidoc/modules/users/pages/protocols/simulated.adoc @@ -19,7 +19,7 @@ = Simulated -include::partial$pom.adoc[] + == Connection String Options diff --git a/website/asciidoc/modules/users/pages/protocols/umas.adoc b/website/asciidoc/modules/users/pages/protocols/umas.adoc index 3a9bd10b730..c894b56aea9 100644 --- a/website/asciidoc/modules/users/pages/protocols/umas.adoc +++ b/website/asciidoc/modules/users/pages/protocols/umas.adoc @@ -19,7 +19,7 @@ = UMAS (Schneider Electric PLCs) -include::partial$pom.adoc[] + (Supported by Plc4Py Only) diff --git a/website/asciidoc/modules/users/pages/security.adoc b/website/asciidoc/modules/users/pages/security.adoc index 578a15b7dc0..5e9a1ed1caf 100644 --- a/website/asciidoc/modules/users/pages/security.adoc +++ b/website/asciidoc/modules/users/pages/security.adoc @@ -17,7 +17,7 @@ = Security Vulnerabilities -include::partial$pom.adoc[] + Please note that binary patches are not produced for individual vulnerabilities. To obtain the binary fix for a particular vulnerability you should upgrade to an Apache PLC4X version where that vulnerability has been fixed. diff --git a/website/asciidoc/modules/users/pages/tools/capture-replay.adoc b/website/asciidoc/modules/users/pages/tools/capture-replay.adoc index f4bb4a3f6cb..0833c46a828 100644 --- a/website/asciidoc/modules/users/pages/tools/capture-replay.adoc +++ b/website/asciidoc/modules/users/pages/tools/capture-replay.adoc @@ -17,7 +17,7 @@ = Capture Replay -include::partial$pom.adoc[] + Sometimes the problem with industry protocols is, that the most interesting protocols live in places that are not very welcoming to IT folks. @@ -47,11 +47,11 @@ Now you need to copy the `pcapng` file ideally to your development system. The capture can be replayed by the tool you find in `plc4j/tools/capture-replay`. -Here simply look for the `target/plc4j-capture-replay-{current-last-released-version}-uber-jar.jar` and run: +Here simply look for the `target/plc4j-capture-replay-{page-component-version}-uber-jar.jar` and run: [subs=attributes+] ---- - java -jar target/plc4j-capture-replay-{current-last-released-version}-uber-jar.jar --input-file {path to capture} --output-device {name of the network device} --replay-speed 1 --loop true + java -jar target/plc4j-capture-replay-{page-component-version}-uber-jar.jar --input-file {path to capture} --output-device {name of the network device} --replay-speed 1 --loop true ---- The options `input-file` and `output-device` are mandatory, the rest is optional: diff --git a/website/asciidoc/modules/users/pages/tools/connection-cache.adoc b/website/asciidoc/modules/users/pages/tools/connection-cache.adoc index 75e39339a9c..6f67064743c 100644 --- a/website/asciidoc/modules/users/pages/tools/connection-cache.adoc +++ b/website/asciidoc/modules/users/pages/tools/connection-cache.adoc @@ -19,7 +19,7 @@ = The Connection Cache concept -include::partial$pom.adoc[] + In some applications there might be multiple parts of the code that require access to a PLC connection. @@ -82,7 +82,7 @@ To use the Connection Cache you have to add a dependency to the `plc4j-connectio org.apache.plc4x plc4j-connection-cache - {current-last-released-version} + {page-component-version} ---- ===================================================================== diff --git a/website/asciidoc/modules/users/pages/tools/connection-pool.adoc b/website/asciidoc/modules/users/pages/tools/connection-pool.adoc index 09ce6a3e121..3eb59937973 100644 --- a/website/asciidoc/modules/users/pages/tools/connection-pool.adoc +++ b/website/asciidoc/modules/users/pages/tools/connection-pool.adoc @@ -19,7 +19,7 @@ = Connection Pool -include::partial$pom.adoc[] + NOTE: The plc4j-connection-pool module has been discontinued and has been removed from PLC4X stating with version 0.11.0 diff --git a/website/asciidoc/modules/users/pages/tools/index.adoc b/website/asciidoc/modules/users/pages/tools/index.adoc index 2ebaf28ae4f..e753cae69b2 100644 --- a/website/asciidoc/modules/users/pages/tools/index.adoc +++ b/website/asciidoc/modules/users/pages/tools/index.adoc @@ -19,4 +19,3 @@ = Tools -include::partial$pom.adoc[] \ No newline at end of file diff --git a/website/asciidoc/modules/users/pages/tools/opm.adoc b/website/asciidoc/modules/users/pages/tools/opm.adoc index f821173e9a0..bb494bf65dd 100644 --- a/website/asciidoc/modules/users/pages/tools/opm.adoc +++ b/website/asciidoc/modules/users/pages/tools/opm.adoc @@ -17,7 +17,7 @@ = Object PLC Mapping -include::partial$pom.adoc[] + == What is Object PLC Mapping diff --git a/website/asciidoc/modules/users/pages/tools/scraper.adoc b/website/asciidoc/modules/users/pages/tools/scraper.adoc index 9c7d1c04c87..bca1171b3a8 100644 --- a/website/asciidoc/modules/users/pages/tools/scraper.adoc +++ b/website/asciidoc/modules/users/pages/tools/scraper.adoc @@ -19,7 +19,7 @@ = Scraper -include::partial$pom.adoc[] + While the Apache PLC4X API allows simple access to PLC resources, if you want to continuously monitor some values and have them retrieved in a pre-defined interval, the core PLC4X API method is a little bit uncomfortable. @@ -39,7 +39,7 @@ The Scraper can be found in the Maven module: org.apache.plc4x plc4j-scraper - {current-last-released-version} + {page-component-version} ---- diff --git a/website/asciidoc/modules/users/pages/tools/testing.adoc b/website/asciidoc/modules/users/pages/tools/testing.adoc index 42e199983d0..706635c6f26 100644 --- a/website/asciidoc/modules/users/pages/tools/testing.adoc +++ b/website/asciidoc/modules/users/pages/tools/testing.adoc @@ -17,7 +17,7 @@ = Testing (or using PLC4X without a PLC) -include::partial$pom.adoc[] + == The Mock Driver @@ -30,7 +30,7 @@ The driver can be found in the Maven module org.apache.plc4x plc4j-driver-mock - {current-last-released-version} + {page-component-version} test ---- diff --git a/website/asciidoc/modules/users/pages/transports/can.adoc b/website/asciidoc/modules/users/pages/transports/can.adoc index 0495de38d68..ac809f0317e 100644 --- a/website/asciidoc/modules/users/pages/transports/can.adoc +++ b/website/asciidoc/modules/users/pages/transports/can.adoc @@ -19,7 +19,7 @@ = CAN -include::partial$pom.adoc[] + A CAN transport is a special category of transport which can bring CAN frame data to various drivers. All of these transports are meant to follow basic CAN frame data semantics. @@ -48,7 +48,7 @@ Note this API is available since Apache PLC4X 0.9. org.apache.plc4x plc4j-transport-can - {current-last-released-version} + {page-component-version} ---- diff --git a/website/asciidoc/modules/users/pages/transports/index.adoc b/website/asciidoc/modules/users/pages/transports/index.adoc index 417151b2615..faebe573902 100644 --- a/website/asciidoc/modules/users/pages/transports/index.adoc +++ b/website/asciidoc/modules/users/pages/transports/index.adoc @@ -19,7 +19,7 @@ = Transports -include::partial$pom.adoc[] + - link:tcp.html[TCP] - link:udp.html[UDP] diff --git a/website/asciidoc/modules/users/pages/transports/pcap-replay.adoc b/website/asciidoc/modules/users/pages/transports/pcap-replay.adoc index 16a61f6af7b..ee7371978cb 100644 --- a/website/asciidoc/modules/users/pages/transports/pcap-replay.adoc +++ b/website/asciidoc/modules/users/pages/transports/pcap-replay.adoc @@ -19,7 +19,7 @@ = PCAP Replay -include::partial$pom.adoc[] + [cols="2,2a,5a"] |=== @@ -38,7 +38,7 @@ include::partial$pom.adoc[] org.apache.plc4x plc4j-transport-pcap-replay - {current-last-released-version} + {page-component-version} ---- diff --git a/website/asciidoc/modules/users/pages/transports/raw-socket.adoc b/website/asciidoc/modules/users/pages/transports/raw-socket.adoc index 92afd9c7bb3..1422e7cd799 100644 --- a/website/asciidoc/modules/users/pages/transports/raw-socket.adoc +++ b/website/asciidoc/modules/users/pages/transports/raw-socket.adoc @@ -19,7 +19,7 @@ = Raw Socket -include::partial$pom.adoc[] + [cols="2,2a,5a"] |=== @@ -38,7 +38,7 @@ include::partial$pom.adoc[] org.apache.plc4x plc4j-transport-raw-socket - {current-last-released-version} + {page-component-version} ---- diff --git a/website/asciidoc/modules/users/pages/transports/serial.adoc b/website/asciidoc/modules/users/pages/transports/serial.adoc index bf6753bc7ec..b85abffc9b2 100644 --- a/website/asciidoc/modules/users/pages/transports/serial.adoc +++ b/website/asciidoc/modules/users/pages/transports/serial.adoc @@ -19,7 +19,7 @@ = Serial Port -include::partial$pom.adoc[] + [cols="2,2a,5a"] |=== @@ -38,7 +38,7 @@ include::partial$pom.adoc[] org.apache.plc4x plc4j-transport-serial - {current-last-released-version} + {page-component-version} ---- diff --git a/website/asciidoc/modules/users/pages/transports/socketcan.adoc b/website/asciidoc/modules/users/pages/transports/socketcan.adoc index 91bd2da76b1..b321e061743 100644 --- a/website/asciidoc/modules/users/pages/transports/socketcan.adoc +++ b/website/asciidoc/modules/users/pages/transports/socketcan.adoc @@ -19,7 +19,7 @@ = SocketCAN -include::partial$pom.adoc[] + [cols="2,2a,5a"] |=== @@ -38,7 +38,7 @@ include::partial$pom.adoc[] org.apache.plc4x plc4j-transport-socketcan - {current-last-released-version} + {page-component-version} ---- diff --git a/website/asciidoc/modules/users/pages/transports/tcp.adoc b/website/asciidoc/modules/users/pages/transports/tcp.adoc index c22f96e19d6..65765242115 100644 --- a/website/asciidoc/modules/users/pages/transports/tcp.adoc +++ b/website/asciidoc/modules/users/pages/transports/tcp.adoc @@ -19,7 +19,7 @@ = TCP -include::partial$pom.adoc[] + [cols="2,2a,5a"] |=== @@ -38,7 +38,7 @@ include::partial$pom.adoc[] org.apache.plc4x plc4j-transport-tcp - {current-last-released-version} + {page-component-version} ---- diff --git a/website/asciidoc/modules/users/pages/transports/udp.adoc b/website/asciidoc/modules/users/pages/transports/udp.adoc index 20e2a9b4e1f..0c2101f7a2d 100644 --- a/website/asciidoc/modules/users/pages/transports/udp.adoc +++ b/website/asciidoc/modules/users/pages/transports/udp.adoc @@ -19,7 +19,7 @@ = UDP -include::partial$pom.adoc[] + [cols="2,2a,5a"] |=== @@ -38,7 +38,7 @@ include::partial$pom.adoc[] org.apache.plc4x plc4j-transport-udp - {current-last-released-version} + {page-component-version} ---- diff --git a/website/asciidoc/modules/users/partials/ab-eth.adoc b/website/asciidoc/modules/users/partials/ab-eth.adoc index 5e168930bb5..e345f4c29fe 100644 --- a/website/asciidoc/modules/users/partials/ab-eth.adoc +++ b/website/asciidoc/modules/users/partials/ab-eth.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-ab-eth - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`raw` diff --git a/website/asciidoc/modules/users/partials/ads.adoc b/website/asciidoc/modules/users/partials/ads.adoc index 3412f6097c7..ae4fd474d27 100644 --- a/website/asciidoc/modules/users/partials/ads.adoc +++ b/website/asciidoc/modules/users/partials/ads.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-ads - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/bacnet-ip.adoc b/website/asciidoc/modules/users/partials/bacnet-ip.adoc index 0e6150f14f6..f6f6c6bcb60 100644 --- a/website/asciidoc/modules/users/partials/bacnet-ip.adoc +++ b/website/asciidoc/modules/users/partials/bacnet-ip.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-bacnet - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`udp` diff --git a/website/asciidoc/modules/users/partials/c-bus.adoc b/website/asciidoc/modules/users/partials/c-bus.adoc index 98da125d166..b19dc5fc63a 100644 --- a/website/asciidoc/modules/users/partials/c-bus.adoc +++ b/website/asciidoc/modules/users/partials/c-bus.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-c-bus - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/canopen.adoc b/website/asciidoc/modules/users/partials/canopen.adoc index ff87b26c636..fd9b02c8746 100644 --- a/website/asciidoc/modules/users/partials/canopen.adoc +++ b/website/asciidoc/modules/users/partials/canopen.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-canopen - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`socketcan` diff --git a/website/asciidoc/modules/users/partials/eip.adoc b/website/asciidoc/modules/users/partials/eip.adoc index 9380b23e8ba..1f8d2bbf1a3 100644 --- a/website/asciidoc/modules/users/partials/eip.adoc +++ b/website/asciidoc/modules/users/partials/eip.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-eip - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/firmata.adoc b/website/asciidoc/modules/users/partials/firmata.adoc index 89061a08c98..551e1a2b61c 100644 --- a/website/asciidoc/modules/users/partials/firmata.adoc +++ b/website/asciidoc/modules/users/partials/firmata.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-firmata - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`serial` diff --git a/website/asciidoc/modules/users/partials/genericcan.adoc b/website/asciidoc/modules/users/partials/genericcan.adoc index 193c38fe041..b49a50d4add 100644 --- a/website/asciidoc/modules/users/partials/genericcan.adoc +++ b/website/asciidoc/modules/users/partials/genericcan.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-can - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`socketcan` diff --git a/website/asciidoc/modules/users/partials/iec-60870-5-104.adoc b/website/asciidoc/modules/users/partials/iec-60870-5-104.adoc index 8368dee5c5d..982376f3f8f 100644 --- a/website/asciidoc/modules/users/partials/iec-60870-5-104.adoc +++ b/website/asciidoc/modules/users/partials/iec-60870-5-104.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-iec-60870 - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/knxnet-ip.adoc b/website/asciidoc/modules/users/partials/knxnet-ip.adoc index 482254e81f1..2e5c1435d26 100644 --- a/website/asciidoc/modules/users/partials/knxnet-ip.adoc +++ b/website/asciidoc/modules/users/partials/knxnet-ip.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-knxnetip - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`udp` diff --git a/website/asciidoc/modules/users/partials/logix.adoc b/website/asciidoc/modules/users/partials/logix.adoc index 773e9d3934c..6bea88dbc33 100644 --- a/website/asciidoc/modules/users/partials/logix.adoc +++ b/website/asciidoc/modules/users/partials/logix.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-eip - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/modbus-ascii.adoc b/website/asciidoc/modules/users/partials/modbus-ascii.adoc index 22f7ebe060a..0187e48935c 100644 --- a/website/asciidoc/modules/users/partials/modbus-ascii.adoc +++ b/website/asciidoc/modules/users/partials/modbus-ascii.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-modbus - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`serial` diff --git a/website/asciidoc/modules/users/partials/modbus-rtu.adoc b/website/asciidoc/modules/users/partials/modbus-rtu.adoc index 589e96f7db7..2c045d71da2 100644 --- a/website/asciidoc/modules/users/partials/modbus-rtu.adoc +++ b/website/asciidoc/modules/users/partials/modbus-rtu.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-modbus - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`serial` diff --git a/website/asciidoc/modules/users/partials/modbus-tcp.adoc b/website/asciidoc/modules/users/partials/modbus-tcp.adoc index 0d8c3d8d10e..5b4bb7c3677 100644 --- a/website/asciidoc/modules/users/partials/modbus-tcp.adoc +++ b/website/asciidoc/modules/users/partials/modbus-tcp.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-modbus - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/opcua.adoc b/website/asciidoc/modules/users/partials/opcua.adoc index b27e3e9bf14..aec5ae8e595 100644 --- a/website/asciidoc/modules/users/partials/opcua.adoc +++ b/website/asciidoc/modules/users/partials/opcua.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-opcua - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/open-protocol.adoc b/website/asciidoc/modules/users/partials/open-protocol.adoc index 164ee59d751..7291d8cf219 100644 --- a/website/asciidoc/modules/users/partials/open-protocol.adoc +++ b/website/asciidoc/modules/users/partials/open-protocol.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-open-protocol - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/plc4x.adoc b/website/asciidoc/modules/users/partials/plc4x.adoc index 4c50a337c8c..3eff6a20e0d 100644 --- a/website/asciidoc/modules/users/partials/plc4x.adoc +++ b/website/asciidoc/modules/users/partials/plc4x.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-plc4x - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/profinet.adoc b/website/asciidoc/modules/users/partials/profinet.adoc index 116490b3846..aca4434a6f9 100644 --- a/website/asciidoc/modules/users/partials/profinet.adoc +++ b/website/asciidoc/modules/users/partials/profinet.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-profinet-ng - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`raw` diff --git a/website/asciidoc/modules/users/partials/s7.adoc b/website/asciidoc/modules/users/partials/s7.adoc index 8b3050507a0..bbdaa7b2b19 100644 --- a/website/asciidoc/modules/users/partials/s7.adoc +++ b/website/asciidoc/modules/users/partials/s7.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-s7 - {current-last-released-version} + {page-component-version} ---- |Default Transport 4+|`tcp` diff --git a/website/asciidoc/modules/users/partials/simulated.adoc b/website/asciidoc/modules/users/partials/simulated.adoc index c2ed88f83f0..1bf4acf1e1a 100644 --- a/website/asciidoc/modules/users/partials/simulated.adoc +++ b/website/asciidoc/modules/users/partials/simulated.adoc @@ -29,7 +29,7 @@ org.apache.plc4x plc4j-driver-simulated - {current-last-released-version} + {page-component-version} ---- |Supported Transports 4+| diff --git a/website/pom.xml b/website/pom.xml index 1ee8e6c4091..db43a69e1f1 100644 --- a/website/pom.xml +++ b/website/pom.xml @@ -172,48 +172,6 @@ - - - - - - - com.google.code.maven-replacer-plugin - replacer - 1.5.3 - - - streamline-font-urls - - false - pre-site - - replace - - - ${project.build.directory}/supplemental/css/all.min.css - - - ../webfonts/ - ../fonts/ - - - - - - - - org.apache.maven.plugins - maven-resources-plugin - copy-site-resources @@ -232,94 +190,94 @@ - - copy-asciidoc - pre-site - - copy-resources - - - ${project.build.directory}/asciidoc - - - - ${project.basedir}/asciidoc - ${project.build.directory}/asciidoc - - - - - - - copy-asciidoc-keys-apache + copy-resources-dir pre-site copy-resources - ${project.build.directory}/asciidoc/modules/apache/partials + ${project.build.directory}/site - ${project.build.directory}/keys - ${project.build.directory}/asciidoc/modules/apache/partials + ${project.basedir}/resources + ${project.build.directory}/site - copy-asciidoc-keys-users + copy-schemas + pre-site copy-resources - ${project.build.directory}/asciidoc/modules/users/partials + ${project.build.directory}/site - ${project.build.directory}/keys - ${project.build.directory}/asciidoc/modules/users/partials + ${project.basedir}/../plc4j/utils/test-utils/src/main/resources/schemas + ${project.build.directory}/site/schemas - copy-asciidoc-keys-developers - pre-site + copy-all-site-resources + + false + site copy-resources - ${project.build.directory}/asciidoc/modules/developers/partials + ${pom.basedir}/../target/site - - ${project.build.directory}/keys - ${project.build.directory}/asciidoc/modules/developers/partials + ${project.build.directory}/site + false + ${pom.basedir}/../target/site + + + + + + + com.google.code.maven-replacer-plugin + replacer + 1.5.3 + - copy-resources-dir + streamline-font-urls + + false pre-site - copy-resources + replace - ${project.build.directory}/site - - - - ${project.basedir}/resources - ${project.build.directory}/site - - + ${project.build.directory}/supplemental/css/all.min.css + + + ../webfonts/ + ../fonts/ + + @@ -375,62 +333,6 @@ ${pom.basedir}/target - - - org.apache.maven.plugins - maven-resources-plugin - - - - copy-schemas - - pre-site - - copy-resources - - - ${project.build.directory}/site - - - - ${project.basedir}/../plc4j/utils/test-utils/src/main/resources/schemas - ${project.build.directory}/site/schemas - - - - - - - - - org.apache.maven.plugins - maven-resources-plugin - - - copy-all-site-resources - - false - site - - copy-resources - - - ${pom.basedir}/../target/site - - - ${project.build.directory}/site - false - ${pom.basedir}/../target/site - - - - - - - maven-clean-plugin diff --git a/website/resources/index.html b/website/resources/index.html index f925a93f4fb..9889f53d113 100644 --- a/website/resources/index.html +++ b/website/resources/index.html @@ -49,7 +49,7 @@