{{$t('Support description paragraph', 'More detailed information on how to use the Proxeus platform can be found in the Handbook.')}}
{{$t('Handbook')}}Your account has been registered successfully. Please wait until we have confirmed the activation of your account. If you have received the account activation confirmation and you are still unable to log in, please make sure you are using the correct MetaMask account using the Ethereum Address you listed in the Access Agreement.
Handbook Privacy Policy From 7deda89cab400ac637d1bdb7bbda8aea0f8f38ab Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Fri, 1 Sep 2023 15:06:40 +0200 Subject: [PATCH 02/10] architecture created and related images moved to this folder --- docs/_media/{ => architecture}/architecture.png | Bin .../{ => architecture}/architecture_overview.png | Bin .../architecture_overview_half.png | Bin docs/architecture.md | 2 +- 4 files changed, 1 insertion(+), 1 deletion(-) rename docs/_media/{ => architecture}/architecture.png (100%) rename docs/_media/{ => architecture}/architecture_overview.png (100%) rename docs/_media/{ => architecture}/architecture_overview_half.png (100%) diff --git a/docs/_media/architecture.png b/docs/_media/architecture/architecture.png similarity index 100% rename from docs/_media/architecture.png rename to docs/_media/architecture/architecture.png diff --git a/docs/_media/architecture_overview.png b/docs/_media/architecture/architecture_overview.png similarity index 100% rename from docs/_media/architecture_overview.png rename to docs/_media/architecture/architecture_overview.png diff --git a/docs/_media/architecture_overview_half.png b/docs/_media/architecture/architecture_overview_half.png similarity index 100% rename from docs/_media/architecture_overview_half.png rename to docs/_media/architecture/architecture_overview_half.png diff --git a/docs/architecture.md b/docs/architecture.md index acdcd540c..bf5673fb0 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -11,7 +11,7 @@ Between client requests and the external resources, we have a classical layered Service and System layers. The System layer is itself responsible to encapsulate the blockchain, database, external node interfaces and for a SPI (service programing interface). Developers can easily create new implementations of those system service layers. - + ### Blockchain Interface From 9ba25805239199fa4ffb903db3b255fc28856ecf Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Fri, 1 Sep 2023 15:19:18 +0200 Subject: [PATCH 03/10] nodes folder nodes folder created and related images moved to this folder --- .../_media/{ => nodes}/background_node_workflow.png | Bin docs/_media/{ => nodes}/external_node.png | Bin docs/_media/{ => nodes}/external_node_half.png | Bin docs/_media/{ => nodes}/external_node_twothird.png | Bin docs/_media/{ => nodes}/node_workflow.png | Bin .../{ => nodes}/xes_payment_sequence_diagram.png | Bin docs/_media/{ => nodes}/xes_payment_state_model.png | Bin docs/backend.md | 4 ++-- docs/external_workflow_nodes.md | 2 +- docs/xes-payment.md | 4 ++-- 10 files changed, 5 insertions(+), 5 deletions(-) rename docs/_media/{ => nodes}/background_node_workflow.png (100%) rename docs/_media/{ => nodes}/external_node.png (100%) rename docs/_media/{ => nodes}/external_node_half.png (100%) rename docs/_media/{ => nodes}/external_node_twothird.png (100%) rename docs/_media/{ => nodes}/node_workflow.png (100%) rename docs/_media/{ => nodes}/xes_payment_sequence_diagram.png (100%) rename docs/_media/{ => nodes}/xes_payment_state_model.png (100%) diff --git a/docs/_media/background_node_workflow.png b/docs/_media/nodes/background_node_workflow.png similarity index 100% rename from docs/_media/background_node_workflow.png rename to docs/_media/nodes/background_node_workflow.png diff --git a/docs/_media/external_node.png b/docs/_media/nodes/external_node.png similarity index 100% rename from docs/_media/external_node.png rename to docs/_media/nodes/external_node.png diff --git a/docs/_media/external_node_half.png b/docs/_media/nodes/external_node_half.png similarity index 100% rename from docs/_media/external_node_half.png rename to docs/_media/nodes/external_node_half.png diff --git a/docs/_media/external_node_twothird.png b/docs/_media/nodes/external_node_twothird.png similarity index 100% rename from docs/_media/external_node_twothird.png rename to docs/_media/nodes/external_node_twothird.png diff --git a/docs/_media/node_workflow.png b/docs/_media/nodes/node_workflow.png similarity index 100% rename from docs/_media/node_workflow.png rename to docs/_media/nodes/node_workflow.png diff --git a/docs/_media/xes_payment_sequence_diagram.png b/docs/_media/nodes/xes_payment_sequence_diagram.png similarity index 100% rename from docs/_media/xes_payment_sequence_diagram.png rename to docs/_media/nodes/xes_payment_sequence_diagram.png diff --git a/docs/_media/xes_payment_state_model.png b/docs/_media/nodes/xes_payment_state_model.png similarity index 100% rename from docs/_media/xes_payment_state_model.png rename to docs/_media/nodes/xes_payment_state_model.png diff --git a/docs/backend.md b/docs/backend.md index 96fe1bb5c..d68348405 100644 --- a/docs/backend.md +++ b/docs/backend.md @@ -39,13 +39,13 @@ There are two internal nodes workflow and condition. These nodes are handled by the engine itself, they are visible in the Stack but they can also be visible in Current(). For example if the root workflow starts with another workflow or a condition. - + #### Background node Successful execution of background node proceeds to the next one without waiting. - + Error when executing a background node. The entire workflow process stops or moves back to the foreground node and waits for the next user interaction. diff --git a/docs/external_workflow_nodes.md b/docs/external_workflow_nodes.md index 1ccaaf3c1..dd8e52da9 100644 --- a/docs/external_workflow_nodes.md +++ b/docs/external_workflow_nodes.md @@ -5,7 +5,7 @@ External workflow nodes are the primary method to extend Proxeus workflow to any They are implemented as external HTTP servers that interact with the Proxeus Core using a simple API. - + During workflow execution, when the state transitions to an external node, the following steps are executed: * Proxeus Core sends the full workflow state the external node, diff --git a/docs/xes-payment.md b/docs/xes-payment.md index b19d7d93f..0bfe33b66 100644 --- a/docs/xes-payment.md +++ b/docs/xes-payment.md @@ -33,10 +33,10 @@ timeout|State indicating either an *abandoned or unsuccessful payment attempt* t The following diagram shows the state transitions of a workflow payment: - + ### Sequence Diagram - + ## Known Issues Due to the distributed and shared nature of the blockchain, in case multiple Proxeus Platform instances would be running, all payments would be shared between these Proxeus Platform instances. Therefore in the rare case where the same buyer and seller (same eth-address in metamask) use various Platform instances it would be possible to pay for a workflow on one instance and use the workflow without payment on another instance. We mitigate the risk of exploiting this behaviour by checking the from-address, to-address and xes-amount in the backend of the Platform. Thanks to this measure the described issue could potentially only arise, in a scenario where the same buyer and same seller of a workflow would be registered on multiple Proxeus Platform Instances and buyer and seller would both have to be registered on 2 or more of the same Proxeus Platform Instances. In addition to that the price of the workflow would have to exactly match the price on the other instances. From 00c2d7b895b956d044fae0aa0bc8fbff8ad9157d Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Fri, 1 Sep 2023 23:14:00 +0200 Subject: [PATCH 04/10] handbook images images renamed --- ...ok_html_2cf30d5758e4a4fa.png => admin-panel.png} | Bin ...Handbook_html_2f5cac16d403f61b.png => api-1.png} | Bin ...Handbook_html_f622e65eb6e6449c.png => api-2.png} | Bin ...book_html_10299e76126cc024.png => condition.png} | Bin ...html_4225235e26b8c178.png => custom-nodes-2.png} | Bin ...k_html_951d02a5e7f5dc31.png => custom-nodes.png} | Bin ...andbook_html_5658bd1d0e8a3e71.png => data-1.png} | Bin ...andbook_html_6544c8b9845e4ce8.png => data-2.png} | Bin ...andbook_html_8649382b98149ec0.png => data-3.png} | Bin ...book_html_5cb7ff81c6e55e5e.png => documents.png} | Bin ...book_html_c6dbc4f60fe085d4.png => downloads.png} | Bin ...ndbook_html_3f41852b7dfa724d.png => forms-1.png} | Bin ...dbook_html_f2247b1e55d57403.png => forms-10.png} | Bin ...ndbook_html_ed735f78a5c0be77.png => forms-2.png} | Bin ...ndbook_html_bd6b023a95f49a54.png => forms-3.png} | Bin ...ndbook_html_b6074b169d306295.png => forms-4.png} | Bin ...andbook_html_7c16ff586c91d22.png => forms-5.png} | Bin ...ndbook_html_8f8c4dee1c7f180e.png => forms-6.png} | Bin ...ndbook_html_7082734f41d7a205.png => forms-7.png} | Bin ...ndbook_html_c9ff17083ce623b0.png => forms-9.png} | Bin ...book_html_d241ff7211167f3a.png => formula-2.png} | Bin ...ndbook_html_8a570ce7f4d583b2.png => formula.png} | Bin ... Handbook_html_63e1e3204a60f7f8.png => logo.png} | Bin ...html_7be2670d2f1892cb.png => multilingual-1.png} | Bin ...html_93d98c7a37d04dc3.png => multilingual-2.png} | Bin ...html_a1d0a25615f373f4.png => multilingual-3.png} | Bin ...html_463f7d37dd1f0f7e.png => multilingual-4.png} | Bin ...7088acfc9ea1.png => requesting-signatures-1.png} | Bin ...3f30ee6d87a2.png => requesting-signatures-2.png} | Bin ...bcac26f7fc4a.png => requesting-signatures-3.png} | Bin ...d01a1f3c3208.png => requesting-signatures-4.png} | Bin ...ok_html_7c96d6635102e938.png => templates-1.png} | Bin ...ook_html_64cf037526a23d7.png => templates-2.png} | Bin ...ok_html_71ee1bf264a4edea.png => templates-3.png} | Bin ...ok_html_90e0d496413daf75.png => templates-4.png} | Bin ...ok_html_9375dbc8240de8f6.png => templates-5.png} | Bin ...ok_html_f74a14eaebbef02b.png => templates-6.png} | Bin ...ok_html_c928046a2a552f00.png => templates-7.png} | Bin ...html_ad8c3d09bed27d94.png => verification-1.png} | Bin ...html_4941424111de63ee.png => verification-2.png} | Bin ...ok_html_64aa240a167179fa.png => workflows-1.png} | Bin ...ok_html_ce291de963f4a5c7.png => workflows-2.png} | Bin ...ok_html_5481d85d82acc650.png => workflows-3.png} | Bin ...ok_html_248280e3a19f5674.png => workflows-5.png} | Bin ...ok_html_e1ea58a054e536e0.png => workflows-6.png} | Bin ...ok_html_d7693cee8e9aac78.png => workflows-7.png} | Bin ...ok_html_7139fb3de33c357a.png => workflows-9.png} | Bin 47 files changed, 0 insertions(+), 0 deletions(-) rename docs/handbook/{Proxeus - The Complete Handbook_html_2cf30d5758e4a4fa.png => admin-panel.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_2f5cac16d403f61b.png => api-1.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_f622e65eb6e6449c.png => api-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_10299e76126cc024.png => condition.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_4225235e26b8c178.png => custom-nodes-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_951d02a5e7f5dc31.png => custom-nodes.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_5658bd1d0e8a3e71.png => data-1.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_6544c8b9845e4ce8.png => data-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_8649382b98149ec0.png => data-3.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_5cb7ff81c6e55e5e.png => documents.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_c6dbc4f60fe085d4.png => downloads.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_3f41852b7dfa724d.png => forms-1.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_f2247b1e55d57403.png => forms-10.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_ed735f78a5c0be77.png => forms-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_bd6b023a95f49a54.png => forms-3.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_b6074b169d306295.png => forms-4.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_7c16ff586c91d22.png => forms-5.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_8f8c4dee1c7f180e.png => forms-6.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_7082734f41d7a205.png => forms-7.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_c9ff17083ce623b0.png => forms-9.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_d241ff7211167f3a.png => formula-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_8a570ce7f4d583b2.png => formula.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_63e1e3204a60f7f8.png => logo.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_7be2670d2f1892cb.png => multilingual-1.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_93d98c7a37d04dc3.png => multilingual-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_a1d0a25615f373f4.png => multilingual-3.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_463f7d37dd1f0f7e.png => multilingual-4.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_b0d27088acfc9ea1.png => requesting-signatures-1.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_f29c3f30ee6d87a2.png => requesting-signatures-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_6061bcac26f7fc4a.png => requesting-signatures-3.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_d007d01a1f3c3208.png => requesting-signatures-4.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_7c96d6635102e938.png => templates-1.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_64cf037526a23d7.png => templates-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_71ee1bf264a4edea.png => templates-3.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_90e0d496413daf75.png => templates-4.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_9375dbc8240de8f6.png => templates-5.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_f74a14eaebbef02b.png => templates-6.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_c928046a2a552f00.png => templates-7.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_ad8c3d09bed27d94.png => verification-1.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_4941424111de63ee.png => verification-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_64aa240a167179fa.png => workflows-1.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_ce291de963f4a5c7.png => workflows-2.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_5481d85d82acc650.png => workflows-3.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_248280e3a19f5674.png => workflows-5.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_e1ea58a054e536e0.png => workflows-6.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_d7693cee8e9aac78.png => workflows-7.png} (100%) rename docs/handbook/{Proxeus - The Complete Handbook_html_7139fb3de33c357a.png => workflows-9.png} (100%) diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_2cf30d5758e4a4fa.png b/docs/handbook/admin-panel.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_2cf30d5758e4a4fa.png rename to docs/handbook/admin-panel.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_2f5cac16d403f61b.png b/docs/handbook/api-1.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_2f5cac16d403f61b.png rename to docs/handbook/api-1.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_f622e65eb6e6449c.png b/docs/handbook/api-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_f622e65eb6e6449c.png rename to docs/handbook/api-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_10299e76126cc024.png b/docs/handbook/condition.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_10299e76126cc024.png rename to docs/handbook/condition.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_4225235e26b8c178.png b/docs/handbook/custom-nodes-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_4225235e26b8c178.png rename to docs/handbook/custom-nodes-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_951d02a5e7f5dc31.png b/docs/handbook/custom-nodes.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_951d02a5e7f5dc31.png rename to docs/handbook/custom-nodes.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_5658bd1d0e8a3e71.png b/docs/handbook/data-1.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_5658bd1d0e8a3e71.png rename to docs/handbook/data-1.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_6544c8b9845e4ce8.png b/docs/handbook/data-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_6544c8b9845e4ce8.png rename to docs/handbook/data-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_8649382b98149ec0.png b/docs/handbook/data-3.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_8649382b98149ec0.png rename to docs/handbook/data-3.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_5cb7ff81c6e55e5e.png b/docs/handbook/documents.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_5cb7ff81c6e55e5e.png rename to docs/handbook/documents.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_c6dbc4f60fe085d4.png b/docs/handbook/downloads.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_c6dbc4f60fe085d4.png rename to docs/handbook/downloads.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_3f41852b7dfa724d.png b/docs/handbook/forms-1.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_3f41852b7dfa724d.png rename to docs/handbook/forms-1.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_f2247b1e55d57403.png b/docs/handbook/forms-10.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_f2247b1e55d57403.png rename to docs/handbook/forms-10.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_ed735f78a5c0be77.png b/docs/handbook/forms-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_ed735f78a5c0be77.png rename to docs/handbook/forms-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_bd6b023a95f49a54.png b/docs/handbook/forms-3.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_bd6b023a95f49a54.png rename to docs/handbook/forms-3.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_b6074b169d306295.png b/docs/handbook/forms-4.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_b6074b169d306295.png rename to docs/handbook/forms-4.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_7c16ff586c91d22.png b/docs/handbook/forms-5.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_7c16ff586c91d22.png rename to docs/handbook/forms-5.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_8f8c4dee1c7f180e.png b/docs/handbook/forms-6.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_8f8c4dee1c7f180e.png rename to docs/handbook/forms-6.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_7082734f41d7a205.png b/docs/handbook/forms-7.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_7082734f41d7a205.png rename to docs/handbook/forms-7.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_c9ff17083ce623b0.png b/docs/handbook/forms-9.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_c9ff17083ce623b0.png rename to docs/handbook/forms-9.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_d241ff7211167f3a.png b/docs/handbook/formula-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_d241ff7211167f3a.png rename to docs/handbook/formula-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_8a570ce7f4d583b2.png b/docs/handbook/formula.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_8a570ce7f4d583b2.png rename to docs/handbook/formula.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_63e1e3204a60f7f8.png b/docs/handbook/logo.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_63e1e3204a60f7f8.png rename to docs/handbook/logo.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_7be2670d2f1892cb.png b/docs/handbook/multilingual-1.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_7be2670d2f1892cb.png rename to docs/handbook/multilingual-1.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_93d98c7a37d04dc3.png b/docs/handbook/multilingual-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_93d98c7a37d04dc3.png rename to docs/handbook/multilingual-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_a1d0a25615f373f4.png b/docs/handbook/multilingual-3.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_a1d0a25615f373f4.png rename to docs/handbook/multilingual-3.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_463f7d37dd1f0f7e.png b/docs/handbook/multilingual-4.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_463f7d37dd1f0f7e.png rename to docs/handbook/multilingual-4.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_b0d27088acfc9ea1.png b/docs/handbook/requesting-signatures-1.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_b0d27088acfc9ea1.png rename to docs/handbook/requesting-signatures-1.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_f29c3f30ee6d87a2.png b/docs/handbook/requesting-signatures-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_f29c3f30ee6d87a2.png rename to docs/handbook/requesting-signatures-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_6061bcac26f7fc4a.png b/docs/handbook/requesting-signatures-3.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_6061bcac26f7fc4a.png rename to docs/handbook/requesting-signatures-3.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_d007d01a1f3c3208.png b/docs/handbook/requesting-signatures-4.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_d007d01a1f3c3208.png rename to docs/handbook/requesting-signatures-4.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_7c96d6635102e938.png b/docs/handbook/templates-1.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_7c96d6635102e938.png rename to docs/handbook/templates-1.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_64cf037526a23d7.png b/docs/handbook/templates-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_64cf037526a23d7.png rename to docs/handbook/templates-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_71ee1bf264a4edea.png b/docs/handbook/templates-3.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_71ee1bf264a4edea.png rename to docs/handbook/templates-3.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_90e0d496413daf75.png b/docs/handbook/templates-4.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_90e0d496413daf75.png rename to docs/handbook/templates-4.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_9375dbc8240de8f6.png b/docs/handbook/templates-5.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_9375dbc8240de8f6.png rename to docs/handbook/templates-5.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_f74a14eaebbef02b.png b/docs/handbook/templates-6.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_f74a14eaebbef02b.png rename to docs/handbook/templates-6.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_c928046a2a552f00.png b/docs/handbook/templates-7.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_c928046a2a552f00.png rename to docs/handbook/templates-7.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_ad8c3d09bed27d94.png b/docs/handbook/verification-1.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_ad8c3d09bed27d94.png rename to docs/handbook/verification-1.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_4941424111de63ee.png b/docs/handbook/verification-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_4941424111de63ee.png rename to docs/handbook/verification-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_64aa240a167179fa.png b/docs/handbook/workflows-1.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_64aa240a167179fa.png rename to docs/handbook/workflows-1.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_ce291de963f4a5c7.png b/docs/handbook/workflows-2.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_ce291de963f4a5c7.png rename to docs/handbook/workflows-2.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_5481d85d82acc650.png b/docs/handbook/workflows-3.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_5481d85d82acc650.png rename to docs/handbook/workflows-3.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_248280e3a19f5674.png b/docs/handbook/workflows-5.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_248280e3a19f5674.png rename to docs/handbook/workflows-5.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_e1ea58a054e536e0.png b/docs/handbook/workflows-6.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_e1ea58a054e536e0.png rename to docs/handbook/workflows-6.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_d7693cee8e9aac78.png b/docs/handbook/workflows-7.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_d7693cee8e9aac78.png rename to docs/handbook/workflows-7.png diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_7139fb3de33c357a.png b/docs/handbook/workflows-9.png similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_7139fb3de33c357a.png rename to docs/handbook/workflows-9.png From 60039ee9931684af60cfc3d7af9770dc5a801161 Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Sat, 2 Sep 2023 00:25:22 +0200 Subject: [PATCH 05/10] Update handbook.md --- docs/handbook.md | 94 ++++++++++++++++++++++++------------------------ 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/docs/handbook.md b/docs/handbook.md index f09a91599..7613836b7 100644 --- a/docs/handbook.md +++ b/docs/handbook.md @@ -31,7 +31,7 @@ Proxeus provides you with a toolbox that already contains everything you need: w - + @@ -179,7 +179,7 @@ You can download your finalized documents as PDFs or Microsoft Word files (only - + ### 4.1.2 Requesting signatures @@ -187,7 +187,7 @@ Once you have completed a workflow and generated a document, you can ask others - + _Your document, opened via “Documents” tab_ @@ -195,7 +195,7 @@ _Your document, opened via “Documents” tab_ Click on the document to see all available actions and find the signature requests on the right: - + _The available actions for your documents: view in browser, download as a PDF or Word file, request signatures_ @@ -210,7 +210,7 @@ The authenticity of documents which were created through the platform can be ver - + _A successful verification - this file has been registered via Proxeus_ @@ -225,7 +225,7 @@ If another user requests your signature, you will find their request in the “S - + _An open signature request_ @@ -286,13 +286,13 @@ Workflows are built by connecting templates, forms and other workflow elements. To create a new workflow, click on “Workflows” in the navigation panel and click on the “Create new” button. - + Enter a “Name” for your new workflow. Optionally, you can add further information in the “Details” field. Click on “✓” and your workflow is created. Click on the newly created workflow to access it. - + @@ -300,7 +300,7 @@ When building a workflow, the templates have to be inserted as the first steps, - + _A simple workflow with one template (pink) and one form (green)_ ### 5.2.2 Price @@ -309,7 +309,7 @@ Creators can decide to make a workflow available to users for a fee. A price of - + _The workflow settings with the price on the right_ @@ -329,7 +329,7 @@ Conditions can be used to guide the user through different paths of a workflow, - + _A workflow with a condition, sending the user to different forms based on inputs from a previous form_ @@ -339,7 +339,7 @@ Proxeus allows you to develop custom nodes and to make them available to all use - + @@ -347,7 +347,7 @@ You can add custom nodes at any position in the workflow. - + _A custom node at the end of our example workflow_ @@ -356,7 +356,7 @@ _A custom node at the end of our example workflow_ In Proxeus, you can also build workflows that call other workflows. The main workflow will start normally and then guide the user through the sub-workflow. After the user has completed this sub-workflow or “workflow in a workflow”, they will be brought back to the main workflow. - + _A workflow with a sub-workflow. The user will see form 1A first, then the forms of the sub-workflow and finally form 2A._ ### 5.2.7 Deleting connections & elements @@ -365,7 +365,7 @@ You can remove connections between workflow elements by clicking on the connecti - + _Deleting the connection between the template and the form_ 5.3 Templates @@ -381,7 +381,7 @@ If the platform has multiple active languages, you may upload one version of the Open the document creator of your choice and save the empty file in ODT format on your local machine. Make sure the filename does not contain any special characters. - + @@ -389,13 +389,13 @@ Open the document creator of your choice and save the empty file in ODT format o Click on “Templates” in the navigation panel and click on the “Create new” button to create a new template. - + Enter a “Name” for your new template. Optionally, you can add further information in the “Details” field. Click on “✓” and your template is created. - + @@ -403,7 +403,7 @@ Enter a “Name” for your new template. Optionally, you can add further inform Click on the newly created template to access it. Drag the ODT file onto the upload area of the respective language or click on the area to browse your local directory and select the right file. - + @@ -419,7 +419,7 @@ To start, you have to access the template you want to work on, upload the templa - + @@ -435,7 +435,7 @@ To directly copy and paste variables, below the upload field, search for your fo - + @@ -504,7 +504,7 @@ The “FOR” Formula is used to loop through an array of values (i.e. from the To gather the birthdays of our friends we have created a field, where multiple entries can be made. - + To add all the entries from this “Dynamic List” to the document the following formula is used: @@ -750,13 +750,13 @@ Forms are used to collect user input throughout a workflow process. The variable To create a new workflow, click on “Workflows” in the navigation panel and click on the “Create new” button. - + Enter a “Name” for your new form. Optionally, you can add further information in the “Details” field. Click on “✓” and your form is created. Click on the newly created form to access the form editor. - + @@ -779,7 +779,7 @@ _The two form editor areas: your form (left) and the form component templates (r - + _A correctly configured component. The name is used as a variable in the ODT Template file._ @@ -795,13 +795,13 @@ In the default view “Workspace”, the forms are built by dragging & dropping - + ### 5.4.3 Action Under Action, the form components can be conditionally linked to each other. This is useful if depending on a form input, more form components should be shown. Simply connect the blue dots of the components. - + _Demonstration of the action mode: depending on the user’s radio button choice,_ _simple_ _field_ _A or B is shown._ @@ -811,13 +811,13 @@ In the “Test” tab, the form can be tested live in action without having to s - + _Demonstration of the Test mode using the “Actions Example” from above._ In the footer of the test tab, there is a “Reset” button to re-initialize the form and a “Play” button that activates the validation to check if the form can be finished with your current inputs. Validation errors such as empty required fields will then be displayed. - + _The Form Reset and Form Validation buttons_ @@ -904,13 +904,13 @@ Add a new code in the translations by filling in the code search and the text se - + The result looks like this: - + @@ -918,7 +918,7 @@ Then navigate to your form and on the component property (e.g. label) that you w - + _Form builder: selecting a translation code to be used for the “Label” property._ @@ -928,7 +928,7 @@ _Form builder: selecting a translation code to be used for the “Label” prope When multiple languages are active, you can upload translated versions of templates: - + @@ -956,7 +956,7 @@ Proxeus imports data with a “best effort” approach, meaning that errors will - + @@ -964,7 +964,7 @@ Under “Workflows”, “Templates” and “Forms”, it is possible to only e - + _Using the search function to only export the “Proxeus Form”._ @@ -992,7 +992,7 @@ In the following UI guides, we’re explaining the different screens you might e 6.1 Admin Panel --------------- - + 1. List of workflows 2. List of templates @@ -1009,7 +1009,7 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.1.1 Workflow - + 1. Back to “Workflows” 2. Share workflow with other users @@ -1029,7 +1029,7 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.1.2 Template - + 1. Back to “Templates” 2. Show/hide document preview @@ -1048,7 +1048,7 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.1.3 Form - + 1. Back to “Forms” 2. Share form @@ -1070,7 +1070,7 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.2.1 Documents - + 1. Execute a workflow to generate a document 2. Search through documents/drafts @@ -1082,14 +1082,14 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.2.2 Verification - + 1. Upload area ### 6.2.3 Signature Requests - + 1. Sign document 2. Reject signature request @@ -1179,7 +1179,7 @@ For the following explanations we’ll assume that you are already working with - + _The “Power up” screen after successful installation_ @@ -1206,7 +1206,7 @@ If you have an export file from a backup or from a different platform, you can l - + _A successful data import_ @@ -1238,13 +1238,13 @@ After setting up your own platform powered by Proxeus, you will be able to custo If you wish to programmatically use the API, your users need to create an API authentication key. This can be done directly in the user profile (top right corner). - + _Name the API key you are generating_ - + _A successful key generation - use this key for API authentication_ @@ -1254,4 +1254,4 @@ _A successful key generation - use this key for API authentication_ Last updated -August 2023 +September 2023 From 641ec93949e5007b3f67d89c77f2beee69493138 Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Sat, 2 Sep 2023 01:16:38 +0200 Subject: [PATCH 06/10] hamdbook img moved to media folder There are some photos that I couldn't categorize, we can categorize them later if needed. --- ...omplete Handbook_html_30ebd5a287e6c904.gif | Bin ...omplete Handbook_html_ead9a2bf0849694e.gif | Bin docs/{ => _media}/handbook/admin-panel.png | Bin .../handbook/api}/api-1.png | Bin .../handbook/api}/api-2.png | Bin docs/{ => _media}/handbook/condition.png | Bin docs/{ => _media}/handbook/custom-nodes-2.png | Bin docs/{ => _media}/handbook/custom-nodes.png | Bin docs/{ => _media}/handbook/data-1.png | Bin docs/{ => _media}/handbook/data-2.png | Bin docs/{ => _media}/handbook/data-3.png | Bin docs/{ => _media}/handbook/documents.png | Bin docs/{ => _media}/handbook/downloads.png | Bin .../handbook/forms}/forms-1.png | Bin .../handbook/forms}/forms-10.png | Bin .../handbook/forms}/forms-2.png | Bin .../handbook/forms}/forms-3.png | Bin .../handbook/forms}/forms-4.png | Bin .../handbook/forms}/forms-5.png | Bin .../handbook/forms}/forms-6.png | Bin .../handbook/forms}/forms-7.png | Bin .../handbook/forms}/forms-9.png | Bin .../handbook/formula}/formula-2.png | Bin .../handbook/formula}/formula.png | Bin docs/{ => _media}/handbook/logo.png | Bin .../handbook/multilingual}/multilingual-1.png | Bin .../handbook/multilingual}/multilingual-2.png | Bin .../handbook/multilingual}/multilingual-3.png | Bin .../handbook/multilingual}/multilingual-4.png | Bin .../requesting-signatures-1.png | Bin .../requesting-signatures-2.png | Bin .../requesting-signatures-3.png | Bin .../requesting-signatures-4.png | Bin .../handbook/templates}/templates-1.png | Bin .../handbook/templates}/templates-2.png | Bin .../handbook/templates}/templates-3.png | Bin .../handbook/templates}/templates-4.png | Bin .../handbook/templates}/templates-5.png | Bin .../handbook/templates}/templates-6.png | Bin .../handbook/templates}/templates-7.png | Bin .../handbook/templates}/verification-1.png | Bin .../handbook/templates}/verification-2.png | Bin .../handbook/workflows}/workflows-1.png | Bin .../handbook/workflows}/workflows-2.png | Bin .../handbook/workflows}/workflows-3.png | Bin .../handbook/workflows}/workflows-5.png | Bin .../handbook/workflows}/workflows-6.png | Bin .../handbook/workflows}/workflows-7.png | Bin .../handbook/workflows}/workflows-9.png | Bin docs/handbook.md | 98 +++++++++--------- 50 files changed, 49 insertions(+), 49 deletions(-) rename docs/{ => _media}/handbook/Proxeus - The Complete Handbook_html_30ebd5a287e6c904.gif (100%) rename docs/{ => _media}/handbook/Proxeus - The Complete Handbook_html_ead9a2bf0849694e.gif (100%) rename docs/{ => _media}/handbook/admin-panel.png (100%) rename docs/{handbook => _media/handbook/api}/api-1.png (100%) rename docs/{handbook => _media/handbook/api}/api-2.png (100%) rename docs/{ => _media}/handbook/condition.png (100%) rename docs/{ => _media}/handbook/custom-nodes-2.png (100%) rename docs/{ => _media}/handbook/custom-nodes.png (100%) rename docs/{ => _media}/handbook/data-1.png (100%) rename docs/{ => _media}/handbook/data-2.png (100%) rename docs/{ => _media}/handbook/data-3.png (100%) rename docs/{ => _media}/handbook/documents.png (100%) rename docs/{ => _media}/handbook/downloads.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-1.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-10.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-2.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-3.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-4.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-5.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-6.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-7.png (100%) rename docs/{handbook => _media/handbook/forms}/forms-9.png (100%) rename docs/{handbook => _media/handbook/formula}/formula-2.png (100%) rename docs/{handbook => _media/handbook/formula}/formula.png (100%) rename docs/{ => _media}/handbook/logo.png (100%) rename docs/{handbook => _media/handbook/multilingual}/multilingual-1.png (100%) rename docs/{handbook => _media/handbook/multilingual}/multilingual-2.png (100%) rename docs/{handbook => _media/handbook/multilingual}/multilingual-3.png (100%) rename docs/{handbook => _media/handbook/multilingual}/multilingual-4.png (100%) rename docs/{handbook => _media/handbook/requesting-signatures}/requesting-signatures-1.png (100%) rename docs/{handbook => _media/handbook/requesting-signatures}/requesting-signatures-2.png (100%) rename docs/{handbook => _media/handbook/requesting-signatures}/requesting-signatures-3.png (100%) rename docs/{handbook => _media/handbook/requesting-signatures}/requesting-signatures-4.png (100%) rename docs/{handbook => _media/handbook/templates}/templates-1.png (100%) rename docs/{handbook => _media/handbook/templates}/templates-2.png (100%) rename docs/{handbook => _media/handbook/templates}/templates-3.png (100%) rename docs/{handbook => _media/handbook/templates}/templates-4.png (100%) rename docs/{handbook => _media/handbook/templates}/templates-5.png (100%) rename docs/{handbook => _media/handbook/templates}/templates-6.png (100%) rename docs/{handbook => _media/handbook/templates}/templates-7.png (100%) rename docs/{handbook => _media/handbook/templates}/verification-1.png (100%) rename docs/{handbook => _media/handbook/templates}/verification-2.png (100%) rename docs/{handbook => _media/handbook/workflows}/workflows-1.png (100%) rename docs/{handbook => _media/handbook/workflows}/workflows-2.png (100%) rename docs/{handbook => _media/handbook/workflows}/workflows-3.png (100%) rename docs/{handbook => _media/handbook/workflows}/workflows-5.png (100%) rename docs/{handbook => _media/handbook/workflows}/workflows-6.png (100%) rename docs/{handbook => _media/handbook/workflows}/workflows-7.png (100%) rename docs/{handbook => _media/handbook/workflows}/workflows-9.png (100%) diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_30ebd5a287e6c904.gif b/docs/_media/handbook/Proxeus - The Complete Handbook_html_30ebd5a287e6c904.gif similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_30ebd5a287e6c904.gif rename to docs/_media/handbook/Proxeus - The Complete Handbook_html_30ebd5a287e6c904.gif diff --git a/docs/handbook/Proxeus - The Complete Handbook_html_ead9a2bf0849694e.gif b/docs/_media/handbook/Proxeus - The Complete Handbook_html_ead9a2bf0849694e.gif similarity index 100% rename from docs/handbook/Proxeus - The Complete Handbook_html_ead9a2bf0849694e.gif rename to docs/_media/handbook/Proxeus - The Complete Handbook_html_ead9a2bf0849694e.gif diff --git a/docs/handbook/admin-panel.png b/docs/_media/handbook/admin-panel.png similarity index 100% rename from docs/handbook/admin-panel.png rename to docs/_media/handbook/admin-panel.png diff --git a/docs/handbook/api-1.png b/docs/_media/handbook/api/api-1.png similarity index 100% rename from docs/handbook/api-1.png rename to docs/_media/handbook/api/api-1.png diff --git a/docs/handbook/api-2.png b/docs/_media/handbook/api/api-2.png similarity index 100% rename from docs/handbook/api-2.png rename to docs/_media/handbook/api/api-2.png diff --git a/docs/handbook/condition.png b/docs/_media/handbook/condition.png similarity index 100% rename from docs/handbook/condition.png rename to docs/_media/handbook/condition.png diff --git a/docs/handbook/custom-nodes-2.png b/docs/_media/handbook/custom-nodes-2.png similarity index 100% rename from docs/handbook/custom-nodes-2.png rename to docs/_media/handbook/custom-nodes-2.png diff --git a/docs/handbook/custom-nodes.png b/docs/_media/handbook/custom-nodes.png similarity index 100% rename from docs/handbook/custom-nodes.png rename to docs/_media/handbook/custom-nodes.png diff --git a/docs/handbook/data-1.png b/docs/_media/handbook/data-1.png similarity index 100% rename from docs/handbook/data-1.png rename to docs/_media/handbook/data-1.png diff --git a/docs/handbook/data-2.png b/docs/_media/handbook/data-2.png similarity index 100% rename from docs/handbook/data-2.png rename to docs/_media/handbook/data-2.png diff --git a/docs/handbook/data-3.png b/docs/_media/handbook/data-3.png similarity index 100% rename from docs/handbook/data-3.png rename to docs/_media/handbook/data-3.png diff --git a/docs/handbook/documents.png b/docs/_media/handbook/documents.png similarity index 100% rename from docs/handbook/documents.png rename to docs/_media/handbook/documents.png diff --git a/docs/handbook/downloads.png b/docs/_media/handbook/downloads.png similarity index 100% rename from docs/handbook/downloads.png rename to docs/_media/handbook/downloads.png diff --git a/docs/handbook/forms-1.png b/docs/_media/handbook/forms/forms-1.png similarity index 100% rename from docs/handbook/forms-1.png rename to docs/_media/handbook/forms/forms-1.png diff --git a/docs/handbook/forms-10.png b/docs/_media/handbook/forms/forms-10.png similarity index 100% rename from docs/handbook/forms-10.png rename to docs/_media/handbook/forms/forms-10.png diff --git a/docs/handbook/forms-2.png b/docs/_media/handbook/forms/forms-2.png similarity index 100% rename from docs/handbook/forms-2.png rename to docs/_media/handbook/forms/forms-2.png diff --git a/docs/handbook/forms-3.png b/docs/_media/handbook/forms/forms-3.png similarity index 100% rename from docs/handbook/forms-3.png rename to docs/_media/handbook/forms/forms-3.png diff --git a/docs/handbook/forms-4.png b/docs/_media/handbook/forms/forms-4.png similarity index 100% rename from docs/handbook/forms-4.png rename to docs/_media/handbook/forms/forms-4.png diff --git a/docs/handbook/forms-5.png b/docs/_media/handbook/forms/forms-5.png similarity index 100% rename from docs/handbook/forms-5.png rename to docs/_media/handbook/forms/forms-5.png diff --git a/docs/handbook/forms-6.png b/docs/_media/handbook/forms/forms-6.png similarity index 100% rename from docs/handbook/forms-6.png rename to docs/_media/handbook/forms/forms-6.png diff --git a/docs/handbook/forms-7.png b/docs/_media/handbook/forms/forms-7.png similarity index 100% rename from docs/handbook/forms-7.png rename to docs/_media/handbook/forms/forms-7.png diff --git a/docs/handbook/forms-9.png b/docs/_media/handbook/forms/forms-9.png similarity index 100% rename from docs/handbook/forms-9.png rename to docs/_media/handbook/forms/forms-9.png diff --git a/docs/handbook/formula-2.png b/docs/_media/handbook/formula/formula-2.png similarity index 100% rename from docs/handbook/formula-2.png rename to docs/_media/handbook/formula/formula-2.png diff --git a/docs/handbook/formula.png b/docs/_media/handbook/formula/formula.png similarity index 100% rename from docs/handbook/formula.png rename to docs/_media/handbook/formula/formula.png diff --git a/docs/handbook/logo.png b/docs/_media/handbook/logo.png similarity index 100% rename from docs/handbook/logo.png rename to docs/_media/handbook/logo.png diff --git a/docs/handbook/multilingual-1.png b/docs/_media/handbook/multilingual/multilingual-1.png similarity index 100% rename from docs/handbook/multilingual-1.png rename to docs/_media/handbook/multilingual/multilingual-1.png diff --git a/docs/handbook/multilingual-2.png b/docs/_media/handbook/multilingual/multilingual-2.png similarity index 100% rename from docs/handbook/multilingual-2.png rename to docs/_media/handbook/multilingual/multilingual-2.png diff --git a/docs/handbook/multilingual-3.png b/docs/_media/handbook/multilingual/multilingual-3.png similarity index 100% rename from docs/handbook/multilingual-3.png rename to docs/_media/handbook/multilingual/multilingual-3.png diff --git a/docs/handbook/multilingual-4.png b/docs/_media/handbook/multilingual/multilingual-4.png similarity index 100% rename from docs/handbook/multilingual-4.png rename to docs/_media/handbook/multilingual/multilingual-4.png diff --git a/docs/handbook/requesting-signatures-1.png b/docs/_media/handbook/requesting-signatures/requesting-signatures-1.png similarity index 100% rename from docs/handbook/requesting-signatures-1.png rename to docs/_media/handbook/requesting-signatures/requesting-signatures-1.png diff --git a/docs/handbook/requesting-signatures-2.png b/docs/_media/handbook/requesting-signatures/requesting-signatures-2.png similarity index 100% rename from docs/handbook/requesting-signatures-2.png rename to docs/_media/handbook/requesting-signatures/requesting-signatures-2.png diff --git a/docs/handbook/requesting-signatures-3.png b/docs/_media/handbook/requesting-signatures/requesting-signatures-3.png similarity index 100% rename from docs/handbook/requesting-signatures-3.png rename to docs/_media/handbook/requesting-signatures/requesting-signatures-3.png diff --git a/docs/handbook/requesting-signatures-4.png b/docs/_media/handbook/requesting-signatures/requesting-signatures-4.png similarity index 100% rename from docs/handbook/requesting-signatures-4.png rename to docs/_media/handbook/requesting-signatures/requesting-signatures-4.png diff --git a/docs/handbook/templates-1.png b/docs/_media/handbook/templates/templates-1.png similarity index 100% rename from docs/handbook/templates-1.png rename to docs/_media/handbook/templates/templates-1.png diff --git a/docs/handbook/templates-2.png b/docs/_media/handbook/templates/templates-2.png similarity index 100% rename from docs/handbook/templates-2.png rename to docs/_media/handbook/templates/templates-2.png diff --git a/docs/handbook/templates-3.png b/docs/_media/handbook/templates/templates-3.png similarity index 100% rename from docs/handbook/templates-3.png rename to docs/_media/handbook/templates/templates-3.png diff --git a/docs/handbook/templates-4.png b/docs/_media/handbook/templates/templates-4.png similarity index 100% rename from docs/handbook/templates-4.png rename to docs/_media/handbook/templates/templates-4.png diff --git a/docs/handbook/templates-5.png b/docs/_media/handbook/templates/templates-5.png similarity index 100% rename from docs/handbook/templates-5.png rename to docs/_media/handbook/templates/templates-5.png diff --git a/docs/handbook/templates-6.png b/docs/_media/handbook/templates/templates-6.png similarity index 100% rename from docs/handbook/templates-6.png rename to docs/_media/handbook/templates/templates-6.png diff --git a/docs/handbook/templates-7.png b/docs/_media/handbook/templates/templates-7.png similarity index 100% rename from docs/handbook/templates-7.png rename to docs/_media/handbook/templates/templates-7.png diff --git a/docs/handbook/verification-1.png b/docs/_media/handbook/templates/verification-1.png similarity index 100% rename from docs/handbook/verification-1.png rename to docs/_media/handbook/templates/verification-1.png diff --git a/docs/handbook/verification-2.png b/docs/_media/handbook/templates/verification-2.png similarity index 100% rename from docs/handbook/verification-2.png rename to docs/_media/handbook/templates/verification-2.png diff --git a/docs/handbook/workflows-1.png b/docs/_media/handbook/workflows/workflows-1.png similarity index 100% rename from docs/handbook/workflows-1.png rename to docs/_media/handbook/workflows/workflows-1.png diff --git a/docs/handbook/workflows-2.png b/docs/_media/handbook/workflows/workflows-2.png similarity index 100% rename from docs/handbook/workflows-2.png rename to docs/_media/handbook/workflows/workflows-2.png diff --git a/docs/handbook/workflows-3.png b/docs/_media/handbook/workflows/workflows-3.png similarity index 100% rename from docs/handbook/workflows-3.png rename to docs/_media/handbook/workflows/workflows-3.png diff --git a/docs/handbook/workflows-5.png b/docs/_media/handbook/workflows/workflows-5.png similarity index 100% rename from docs/handbook/workflows-5.png rename to docs/_media/handbook/workflows/workflows-5.png diff --git a/docs/handbook/workflows-6.png b/docs/_media/handbook/workflows/workflows-6.png similarity index 100% rename from docs/handbook/workflows-6.png rename to docs/_media/handbook/workflows/workflows-6.png diff --git a/docs/handbook/workflows-7.png b/docs/_media/handbook/workflows/workflows-7.png similarity index 100% rename from docs/handbook/workflows-7.png rename to docs/_media/handbook/workflows/workflows-7.png diff --git a/docs/handbook/workflows-9.png b/docs/_media/handbook/workflows/workflows-9.png similarity index 100% rename from docs/handbook/workflows-9.png rename to docs/_media/handbook/workflows/workflows-9.png diff --git a/docs/handbook.md b/docs/handbook.md index 7613836b7..e363c89d6 100644 --- a/docs/handbook.md +++ b/docs/handbook.md @@ -31,7 +31,7 @@ Proxeus provides you with a toolbox that already contains everything you need: w - + @@ -179,7 +179,7 @@ You can download your finalized documents as PDFs or Microsoft Word files (only - + ### 4.1.2 Requesting signatures @@ -187,7 +187,7 @@ Once you have completed a workflow and generated a document, you can ask others - + _Your document, opened via “Documents” tab_ @@ -195,7 +195,7 @@ _Your document, opened via “Documents” tab_ Click on the document to see all available actions and find the signature requests on the right: - + _The available actions for your documents: view in browser, download as a PDF or Word file, request signatures_ @@ -210,7 +210,7 @@ The authenticity of documents which were created through the platform can be ver - + _A successful verification - this file has been registered via Proxeus_ @@ -225,7 +225,7 @@ If another user requests your signature, you will find their request in the “S - + _An open signature request_ @@ -286,13 +286,13 @@ Workflows are built by connecting templates, forms and other workflow elements. To create a new workflow, click on “Workflows” in the navigation panel and click on the “Create new” button. - + Enter a “Name” for your new workflow. Optionally, you can add further information in the “Details” field. Click on “✓” and your workflow is created. Click on the newly created workflow to access it. - + @@ -300,7 +300,7 @@ When building a workflow, the templates have to be inserted as the first steps, - + _A simple workflow with one template (pink) and one form (green)_ ### 5.2.2 Price @@ -309,7 +309,7 @@ Creators can decide to make a workflow available to users for a fee. A price of - + _The workflow settings with the price on the right_ @@ -329,7 +329,7 @@ Conditions can be used to guide the user through different paths of a workflow, - + _A workflow with a condition, sending the user to different forms based on inputs from a previous form_ @@ -339,7 +339,7 @@ Proxeus allows you to develop custom nodes and to make them available to all use - + @@ -347,7 +347,7 @@ You can add custom nodes at any position in the workflow. - + _A custom node at the end of our example workflow_ @@ -356,7 +356,7 @@ _A custom node at the end of our example workflow_ In Proxeus, you can also build workflows that call other workflows. The main workflow will start normally and then guide the user through the sub-workflow. After the user has completed this sub-workflow or “workflow in a workflow”, they will be brought back to the main workflow. - + _A workflow with a sub-workflow. The user will see form 1A first, then the forms of the sub-workflow and finally form 2A._ ### 5.2.7 Deleting connections & elements @@ -365,7 +365,7 @@ You can remove connections between workflow elements by clicking on the connecti - + _Deleting the connection between the template and the form_ 5.3 Templates @@ -381,7 +381,7 @@ If the platform has multiple active languages, you may upload one version of the Open the document creator of your choice and save the empty file in ODT format on your local machine. Make sure the filename does not contain any special characters. - + @@ -389,13 +389,13 @@ Open the document creator of your choice and save the empty file in ODT format o Click on “Templates” in the navigation panel and click on the “Create new” button to create a new template. - + Enter a “Name” for your new template. Optionally, you can add further information in the “Details” field. Click on “✓” and your template is created. - + @@ -403,7 +403,7 @@ Enter a “Name” for your new template. Optionally, you can add further inform Click on the newly created template to access it. Drag the ODT file onto the upload area of the respective language or click on the area to browse your local directory and select the right file. - + @@ -419,7 +419,7 @@ To start, you have to access the template you want to work on, upload the templa - + @@ -435,7 +435,7 @@ To directly copy and paste variables, below the upload field, search for your fo - + @@ -455,7 +455,7 @@ In order to test whether the template file you uploaded behaves as desired, a te - + @@ -504,7 +504,7 @@ The “FOR” Formula is used to loop through an array of values (i.e. from the To gather the birthdays of our friends we have created a field, where multiple entries can be made. - + To add all the entries from this “Dynamic List” to the document the following formula is used: @@ -517,7 +517,7 @@ To add all the entries from this “Dynamic List” to the document the followin This will create a bullet point list (it works with other formatting too): - + For checkboxes, the following formula can be used: @@ -750,13 +750,13 @@ Forms are used to collect user input throughout a workflow process. The variable To create a new workflow, click on “Workflows” in the navigation panel and click on the “Create new” button. - + Enter a “Name” for your new form. Optionally, you can add further information in the “Details” field. Click on “✓” and your form is created. Click on the newly created form to access the form editor. - + @@ -773,13 +773,13 @@ The basic steps are: - + _The two form editor areas: your form (left) and the form component templates (right)_ - + _A correctly configured component. The name is used as a variable in the ODT Template file._ @@ -795,13 +795,13 @@ In the default view “Workspace”, the forms are built by dragging & dropping - + ### 5.4.3 Action Under Action, the form components can be conditionally linked to each other. This is useful if depending on a form input, more form components should be shown. Simply connect the blue dots of the components. - + _Demonstration of the action mode: depending on the user’s radio button choice,_ _simple_ _field_ _A or B is shown._ @@ -811,13 +811,13 @@ In the “Test” tab, the form can be tested live in action without having to s - + _Demonstration of the Test mode using the “Actions Example” from above._ In the footer of the test tab, there is a “Reset” button to re-initialize the form and a “Play” button that activates the validation to check if the form can be finished with your current inputs. Validation errors such as empty required fields will then be displayed. - + _The Form Reset and Form Validation buttons_ @@ -904,13 +904,13 @@ Add a new code in the translations by filling in the code search and the text se - + The result looks like this: - + @@ -918,7 +918,7 @@ Then navigate to your form and on the component property (e.g. label) that you w - + _Form builder: selecting a translation code to be used for the “Label” property._ @@ -928,7 +928,7 @@ _Form builder: selecting a translation code to be used for the “Label” prope When multiple languages are active, you can upload translated versions of templates: - + @@ -956,7 +956,7 @@ Proxeus imports data with a “best effort” approach, meaning that errors will - + @@ -964,7 +964,7 @@ Under “Workflows”, “Templates” and “Forms”, it is possible to only e - + _Using the search function to only export the “Proxeus Form”._ @@ -992,7 +992,7 @@ In the following UI guides, we’re explaining the different screens you might e 6.1 Admin Panel --------------- - + 1. List of workflows 2. List of templates @@ -1009,7 +1009,7 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.1.1 Workflow - + 1. Back to “Workflows” 2. Share workflow with other users @@ -1029,7 +1029,7 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.1.2 Template - + 1. Back to “Templates” 2. Show/hide document preview @@ -1048,7 +1048,7 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.1.3 Form - + 1. Back to “Forms” 2. Share form @@ -1070,7 +1070,7 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.2.1 Documents - + 1. Execute a workflow to generate a document 2. Search through documents/drafts @@ -1082,14 +1082,14 @@ In the following UI guides, we’re explaining the different screens you might e ### 6.2.2 Verification - + 1. Upload area ### 6.2.3 Signature Requests - + 1. Sign document 2. Reject signature request @@ -1179,7 +1179,7 @@ For the following explanations we’ll assume that you are already working with - + _The “Power up” screen after successful installation_ @@ -1206,7 +1206,7 @@ If you have an export file from a backup or from a different platform, you can l - + _A successful data import_ @@ -1238,13 +1238,13 @@ After setting up your own platform powered by Proxeus, you will be able to custo If you wish to programmatically use the API, your users need to create an API authentication key. This can be done directly in the user profile (top right corner). - + _Name the API key you are generating_ - + _A successful key generation - use this key for API authentication_ From 938935aa9493c574824ea954d609717371fab012 Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Mon, 4 Sep 2023 11:35:39 +0200 Subject: [PATCH 07/10] Img file location fixed --- .../handbook/{templates => }/verification-1.png | Bin .../handbook/{templates => }/verification-2.png | Bin 2 files changed, 0 insertions(+), 0 deletions(-) rename docs/_media/handbook/{templates => }/verification-1.png (100%) rename docs/_media/handbook/{templates => }/verification-2.png (100%) diff --git a/docs/_media/handbook/templates/verification-1.png b/docs/_media/handbook/verification-1.png similarity index 100% rename from docs/_media/handbook/templates/verification-1.png rename to docs/_media/handbook/verification-1.png diff --git a/docs/_media/handbook/templates/verification-2.png b/docs/_media/handbook/verification-2.png similarity index 100% rename from docs/_media/handbook/templates/verification-2.png rename to docs/_media/handbook/verification-2.png From bdc8b4cdc0ff5df2a2c4f93ca41707daa94a58d2 Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Mon, 4 Sep 2023 15:08:22 +0200 Subject: [PATCH 08/10] sidebar made more accessible --- docs/handbook.md | 13 ------------- docs/index.html | 1 + 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/docs/handbook.md b/docs/handbook.md index e363c89d6..6f339e7ef 100644 --- a/docs/handbook.md +++ b/docs/handbook.md @@ -3,21 +3,8 @@ - -## Table of Contents -1. **[Introduction](#_1-introduction)** -1. **[Requirements](#_2-requirements)** -1. **[Your Account](#_3-your-account)** -1. **[User View](#_4-user-view)** -1. **[Admin Panel](#_5-admin-panel)** -1. **[UI Guides](#_6-ui-guides)** -1. **[Roles](#_7-roles)** -1. **[Platform Installation](#_8-platform-installation)** - ---- - 1 Introduction ============== diff --git a/docs/index.html b/docs/index.html index ed4917017..d3916c776 100644 --- a/docs/index.html +++ b/docs/index.html @@ -25,6 +25,7 @@ coverpage: true, logo: '/_media/proxeus_logo.svg', loadSidebar: true, + subMaxLevel: 1, loadNavbar: true, name: '', repo: '' From 1a4e5ab0956a3b30e38a7c597a4e8688ee5761c1 Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Mon, 4 Sep 2023 17:37:06 +0200 Subject: [PATCH 09/10] about and sidebar --- docs/_sidebar.md | 4 ++++ docs/about.md | 20 ++++++++++---------- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 2903843bb..b5d4091d0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,5 +1,9 @@ - [](https://proxeus.org) + +- Proxeus Association + - [About](about.md) + - Getting started - [Quick start](quickstart.md) diff --git a/docs/about.md b/docs/about.md index dbf6b23c6..e77eab252 100644 --- a/docs/about.md +++ b/docs/about.md @@ -3,7 +3,7 @@ The association is the governing body responsible for the maintenance and development of the Proxeus software. We also aim to encourage innovation and evangelize the project by launching and supporting community initiatives as well as creating synergies and partnerships with relevant community projects. Governance ----------- +========== The Association is working to give the project a decentralized structure to allow our members to propose guidance on the software. Our mission is to make the Proxeus software the 'WordPress' of the blockchain - in other words, to democratize access, and lower the costs of deployment of small blockchain applications. @@ -12,12 +12,12 @@ Some of the benefits of getting involved with the Association, is the ability to See also the [Contributing](contributing) section, and visit our [Community Forum](https://github.com/ProxeusApp/community/discussions) if you have any questions about the project - or write to us at association@proxeus.org Statutes --------- +======== Proxeus Association is a non-profit association governed by the present statutes and, secondly, by Articles 60 et seq. of the Swiss Civil Code. It is politically neutral, and non-denominational. OVERVIEW --------- +======== ### Article 2 @@ -26,7 +26,7 @@ OVERVIEW - Duration: The Association shall be of unlimited duration. GOALS ------ +===== ### Article 3 @@ -41,7 +41,7 @@ The Proxeus software is a powerful workflow engine with blockchain capabilities - foster innovation and evangelize the project by launching and supporting community initiatives, as well as by creating synergies and partnering with relevant community- driven projects. RESOURCES ---------- +========= ### Article 4 @@ -60,7 +60,7 @@ The Association's resources are derived from: - The funds shall be used in accordance with the goals of the Association. MEMBERS -------- +======= ### Article 5 @@ -79,7 +79,7 @@ Membership terminates: - Upon death / bankruptcy / liquidation of a member. In all cases of termination, the membership fee (if applicable) for the current year remains due. Members who have resigned or who are excluded have no rights to any part of the Association's assets. No financial liability of Members: Only the Association's assets may be used for obligations/commitments contracted in its name. Members have no personal liability whatsoever. ORGANS ------- +====== ### Article 6 @@ -90,7 +90,7 @@ The Association shall include the following organs: - Executive Board GENERAL ASSEMBLY ----------------- +================ ### Article 7 @@ -159,7 +159,7 @@ Agenda of Ordinary Meeting: The agenda of the Ordinary Meeting of the General As - Miscellaneous business. EXECUTIVE BOARD ---------------- +=============== ### Article 13 @@ -198,7 +198,7 @@ Legal requirement to elect Auditors: The Auditors have to be elected by the Gene Voluntary election of Auditors: The General Assembly may, with a two-thirds majority, request the election of an auditor for a limited audit of the accounting even if the above criteria are not met. Responsibilities of Auditors: The auditor shall check the operating and annual accounts prepared by the Executive Board and present a written and detailed report to the General Assembly. VARIOUS PROVISIONS ------------------- +================== ### Article 17 From 631565f49c0deed078d091c3fcf2d45bd1aec6ca Mon Sep 17 00:00:00 2001 From: Ibrahim-Halil-Kuray <71791007+Ibrahim-Halil-Kuray@users.noreply.github.com> Date: Mon, 4 Sep 2023 18:20:19 +0200 Subject: [PATCH 10/10] Footer added Mail, address and github --- docs/index.html | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/index.html b/docs/index.html index d3916c776..491b4ffa8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -28,7 +28,23 @@ subMaxLevel: 1, loadNavbar: true, name: '', - repo: '' + repo: '', + plugins: [ + function pageFooter(hook, vm) { + let footer = [ + '