Skip to content

Commit 55f9ce5

Browse files
Vinyl-DavylVinyl-Davyl
authored
update: development (#97)
Signed-off-by: Vinyl-Davyl <okononfuadavid@gmail.com>
1 parent 0d206bd commit 55f9ce5

File tree

4 files changed

+330
-0
lines changed

4 files changed

+330
-0
lines changed

‎src/content/intro.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Overview
2+
3+
The Accord Project Template Playground is an innovative web-based platform designed to empower developers and enthusiasts to explore and experiment with Accord Project functionalities in an interactive and user-friendly environment. This playground serves as your hands-on tool for working with Accord Project templates, offering a rich set of features to facilitate learning and experimentation.
4+
5+
## What is the Accord Project?
6+
7+
The Accord Project is an open-source, non-profit initiative dedicated to transforming contract management and automation through digital contracts. By providing a standardized format for _Smart Legal Contracts_, the Accord Project aims to modernize traditional contract practices with a digitized approach.
8+
9+
At the core of the Accord Project are templates that blend _natural language text_ with computing logic. These templates function similarly to clauses or contract templates but are designed to be both human-readable and machine-executable. This innovative format bridges the gap between static documentation and dynamic, interactive contract management.
10+
11+
![AP](/public/APLogo.png)
12+
13+
## Key Components of the Template Playground
14+
15+
The Template Playground allows you to dive into several key Accord Project technologies:
16+
17+
1. **TemplateMark**: This feature lets you work with natural language text within templates. TemplateMark is crucial for defining the text-based structure of contracts.
18+
19+
2. **[Concerto](https://docs.accordproject.org/docs/model-concerto.html)**: Concerto serves as the data model that bridges the natural language text and the executable logic. It outlines the structure and data types used within the templates.
20+
21+
3. **[Markdown-Transform](https://github.com/accordproject/markdown-transform)**: This tool transforms the template output into various formats such as HTML, PDF, etc., offering flexibility in presentation.
22+
23+
4. **[Template-Engine](https://github.com/accordproject/template-engine)**: The Template Engine converts TemplateMark and JSON data into _AgreementMark_, a standardized format for Smart Legal Contracts.
24+
25+
## Interactive Features
26+
27+
The Template Playground is designed to enrich your learning experience with interactive features:
28+
29+
- **Live Template Testing and Editing**: Edit and test template samples directly in the playground. Syntax highlighting and error checking ensure your templates are accurate and functional.
30+
31+
- **Real-Time Preview**: View the results of your code execution instantly. The playground provides a live preview of your work, allowing you to see the output in real time.
32+
33+
- **Shareable Links**: Share your edited templates with others effortlessly. The playground generates shareable links, enabling collaboration and showcasing your work.
34+
35+
## Getting Started
36+
37+
To get started with the Template Playground:
38+
39+
1. **Select a Template**: Choose from various pre-built templates available in the dropdown menu. The "Hello World" template is an excellent starting point for beginners.
40+
41+
2. **Experiment with TemplateMark**: Begin by exploring the natural language text of the template. Modify and observe how changes affect the output.
42+
43+
3. **Explore the Concerto Model**: Dive into the data model supporting your template. Understand how the model integrates with the template text and logic.
44+
45+
4. **Define Template Logic**: Implement and test the business logic for your template. Use JSON data to preview how your logic interacts with the template.
46+
47+
5. **Preview Output**: Utilize the preview feature to view the final result of your work. The playground provides an easy way to see how your template looks and functions.
48+
49+
## What’s Next?
50+
51+
In the upcoming module, we will delve deeply into **_TemplateMark_**—the natural language component of templates. You’ll learn how to create and experiment with templates, exploring the structure and syntax that make TemplateMark a powerful tool for defining contracts. This hands-on experience will provide you with a solid foundation for building and understanding templates in the Accord Project.

‎src/content/module1.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Module 1: Introduction to TemplateMark
2+
3+
The **TemplateMark** language is a crucial element of the Accord Project template system. It allows you to craft templates using a mix of _natural language text_ and _markup syntax_, making it possible to create documents that are both _human-readable_ and _machine-readable_. In this module, we will delve into the basics of TemplateMark, showcasing its key features and demonstrating its practical application within the Accord Project Template Playground.
4+
5+
## What is TemplateMark?
6+
7+
TemplateMark is a markup language used for defining templates in the Accord Project. It combines plain text with specific notations, enabling templates to be interpreted and processed by computers while remaining understandable to humans.
8+
9+
![Template Text](/public/assets/content/template_text.png)
10+
11+
Templates in Accord Project are made up of three essential elements:
12+
13+
- **Template Text**: The natural language content of the template.
14+
- **Template Model**: The data model that provides the connection between the text and the executable logic.
15+
- **Template Logic**: The business rules and logic that define how the template is processed and used.
16+
17+
These components work together to create a powerful tool for contract automation and management.
18+
19+
## Example of Template Text
20+
21+
Let's explore a TemplateMark example for a **Service Agreement** clause:
22+
23+
```js
24+
## Service Agreement
25+
26+
{{provider}} agrees to provide the following services to {{client}}:
27+
28+
- **Service 1**: {{service1Description}}
29+
- **Service 2**: {{service2Description}}
30+
31+
The services will be delivered according to the following schedule:
32+
33+
- **Start Date**: {{startDate as "D MMMM YYYY"}}
34+
- **End Date**: {{endDate as "D MMMM YYYY"}}
35+
36+
Payment terms are as follows:
37+
38+
- **Amount**: {{paymentAmount as "0,0.00 USD"}}
39+
- **Due Date**: {{paymentDueDate as "D MMMM YYYY"}}
40+
41+
Any changes to the service agreement must be documented in writing and agreed upon by both parties.
42+
```
43+
44+
In this template:
45+
46+
- `{{provider}}`, `{{client}}`, `{{service1Description}}`, `{{service2Description}}`, `{{startDate}}`, `{{endDate}}`, `{{paymentAmount}}`, and `{{paymentDueDate}}` are placeholders that will be replaced with actual values when the template is used.
47+
48+
Here's how the same clause looks with placeholder values filled in:
49+
50+
```md
51+
## Service Agreement
52+
53+
"ABC Services Ltd." agrees to provide the following services to "XYZ Corp":
54+
55+
- **Service 1**: Monthly IT support and maintenance
56+
- **Service 2**: On-site technical assistance
57+
58+
The services will be delivered according to the following schedule:
59+
60+
- **Start Date**: 1 September 2024
61+
- **End Date**: 31 August 2025
62+
63+
Payment terms are as follows:
64+
65+
- **Amount**: $5,000.00
66+
- **Due Date**: 1 September 2024
67+
68+
Any changes to the service agreement must be documented in writing and agreed upon by both parties.
69+
```
70+
71+
## Key Features of TemplateMark
72+
73+
- **Variables**: Use `{{` and `}}` to denote placeholders in your template. These placeholders are replaced with specific values during template processing.
74+
- **Conditional Sections**: Incorporate or exclude sections based on conditions using `{{#clause}} ... {{/clause}}`.
75+
- **Formatting**: Apply formatting like bold or italics to emphasize important terms.
76+
- **Lists**: Organize information using ordered or unordered lists.
77+
78+
## Practical Example in the Playground
79+
80+
In the Template Playground, you can interact with TemplateMark templates such as:
81+
82+
```js
83+
### Welcome {{username}}!
84+
85+
![Logo](https://avatars.githubusercontent.com/u/29445438?s=64)
86+
87+
{{#clause personalDetails}}
88+
#### Personal Details
89+
> {{firstName}} {{lastName}},
90+
{{address}}, {{city}}, {{state}},
91+
{{country}}
92+
{{/clause}}
93+
94+
- Your date of birth is *{{dob as "D MMMM YYYY"}}*
95+
- Your annual salary is {{annualSalary as "0,0.00 USD"}}
96+
- Your preferred contact method is {{contactMethod}}
97+
98+
{{#clause recentActivity}}
99+
## Recent Activity
100+
You signed up on {{signupDate as "D MMMM YYYY"}} ({{% return now.diff(user.signupDate, 'day')%}} days ago).
101+
102+
{{#ulist recentPurchases}}
103+
- {{quantity}}x _{{item}}_ @ ${{price as "0,0.00"}}
104+
{{/ulist}}
105+
Total spent: {{% return '£' + user.recentPurchases.map(purchase => purchase.price * purchase.quantity).reduce((sum, cur) => sum + cur).toFixed(2);%}}
106+
{{/clause}}
107+
108+
Thank you for being with us!
109+
```
110+
111+
In this example:
112+
113+
- **Welcome Message**: Personalize messages with dynamic values.
114+
- **Personal Details Clause**: Display personal information conditionally.
115+
- **Recent Activity**: List recent purchases with calculations.
116+
117+
## Summary
118+
119+
In this module, we introduced TemplateMark, highlighting its role in creating flexible and dynamic templates. By understanding TemplateMark, you can build templates that combine natural language with computer logic, enabling sophisticated document automation and management.
120+
121+
## What's Next?
122+
123+
In the next module, we'll explore the **Template Model**—the data structure that supports and enhances the TemplateMark text. We'll cover how the Template Model integrates with TemplateMark to enable dynamic and functional templates. Stay tuned for a deep dive into the data modeling aspect of Accord Project templates!

‎src/content/module2.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Module 2: Understanding the Template Model
2+
3+
In this module, we'll explore the **Template Model**, a crucial component of the Accord Project template system. The Template Model defines the data structure that supports the natural language text in your templates, providing a bridge between the text and the executable logic. Understanding the Template Model will help you grasp how data is categorized and utilized within Accord Project templates.
4+
5+
## What is the Template Model?
6+
7+
Unlike standard document templates (such as those created in Word or PDF), Accord Project templates use a _Template Model_ to associate a structured data model with the natural language text. This model categorizes and defines the types of different components used in the template, enabling the computer to understand and process the information effectively.
8+
9+
![Template Model](/public/assets/content/template_model.png)
10+
11+
The Template Model categorizes variables into different types—such as numbers, monetary amounts, dates, or references to organizations—allowing the computer to interpret the template's data correctly.
12+
13+
## Example of a Template Model
14+
15+
Let's examine a Template Model for a **Service Agreement** clause:
16+
17+
```js
18+
/* The template model */
19+
namespace service@1.0.0
20+
21+
concept Address {
22+
o String line1
23+
o String city
24+
o String state
25+
o String country
26+
}
27+
28+
concept Service {
29+
o String serviceName
30+
o String description
31+
o DateTime serviceDate
32+
}
33+
34+
concept PaymentDetails {
35+
o MonetaryAmount amount
36+
o DateTime dueDate
37+
}
38+
39+
@template
40+
concept ServiceAgreementData {
41+
o String clientName
42+
o Address clientAddress
43+
o Service[] services
44+
o PaymentDetails payment
45+
}
46+
```
47+
48+
In this model:
49+
50+
- **`Address`** defines the structure for addresses, including line1, city, state, and country.
51+
- **`Service`** specifies the details of the services being provided, including the service name, description, and service date.
52+
- **`PaymentDetails`** outlines the payment information, including the amount and due date.
53+
- **`ServiceAgreementData`** is the main data concept used in the template, incorporating `clientName`, `clientAddress`, a list of `services`, and `payment`.
54+
55+
### Key Components
56+
57+
- **Concepts**: Define data structures and types used in the template. For instance, `Address` and `Service` are concepts that model different types of data.
58+
- **Attributes**: Specify the type of data each concept holds, such as `String`, `Integer`, `DateTime`, or `MonetaryAmount`.
59+
- **Namespaces**: Organize and manage different versions of the models, such as `service@1.0.0`.
60+
61+
## Concerto
62+
63+
The Template Model is written in **Concerto**, a language used to define data models in Accord Project templates. Concerto supports a range of modeling capabilities, including:
64+
65+
- Primitive types (e.g., numbers, dates)
66+
- Nested and optional data structures
67+
- Enumerations and relationships
68+
- Object-oriented style inheritance
69+
70+
_More information about Concerto can be found in the [Concerto Model](https://concerto.accordproject.org/docs/intro) section of this documentation._
71+
72+
## Summary
73+
74+
In this module, we've introduced the Template Model, showcasing its role in defining and structuring the data used in Accord Project templates. By understanding the Template Model, you can create more sophisticated and functional templates that integrate seamlessly with TemplateMark text.
75+
76+
## What's Next?
77+
78+
In the next module, we'll dive into **Template Logic**—the business rules and logic that govern how templates are processed and executed. You'll learn how to implement and test the logic that drives template functionality, enhancing your ability to create dynamic and interactive templates. Stay tuned for an in-depth exploration of Template Logic!

‎src/content/module3.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Module 3: Exploring Template Logic
2+
3+
In this module, we will dive into **Template Logic**, the component that makes Accord Project templates not just machine-readable but also machine-executable. Template Logic allows you to embed rules and functions within your templates, enabling dynamic calculations and automated processing of contract data.
4+
5+
## What is Template Logic?
6+
7+
While the Template Text and Template Model ensure that your templates are well-structured and machine-readable, Template Logic adds the capability to perform computations and enforce rules based on the data. This makes your templates not only executable but also interactive and adaptive to various scenarios.
8+
9+
![Template Logic](/public/assets/content/template_logic.png)
10+
11+
### Logic During Drafting
12+
13+
Template Logic can be embedded directly within the template text to perform real-time calculations or transformations based on the provided data. For example, consider a **Service Cost Estimate** template that calculates the total cost of services based on hourly rates and hours worked:
14+
15+
```js
16+
## Service Cost Estimate
17+
18+
This document provides an estimate for the services requested by {{clientName}}.
19+
20+
### Service Details
21+
22+
- Service: {{serviceName}}
23+
- Hours Worked: {{hoursWorked}}
24+
- Hourly Rate: {{hourlyRate as "0,0.00"}}
25+
- Estimated Total Cost: {{% calculateTotalCost(hoursWorked, hourlyRate) %}}
26+
27+
Thank you for considering our services.
28+
```
29+
30+
In this example, `calculateTotalCost` is a function that computes the total cost based on the hours worked and the hourly rate:
31+
32+
```js
33+
define function calculateTotalCost(hoursWorked: Integer, hourlyRate: Double) : Double {
34+
return hoursWorked * hourlyRate;
35+
}
36+
```
37+
38+
Here, `calculateTotalCost` takes `hoursWorked` and `hourlyRate` as inputs and returns the total cost. The function uses simple arithmetic operations to compute the result.
39+
40+
### Logic After Signature
41+
42+
Template Logic can also be applied to enforce rules or conditions after a contract has been signed. For instance, imagine a **Warranty Agreement** that needs to verify if a warranty claim is valid based on the date of purchase and the claim submission date:
43+
44+
```js
45+
contract WarrantyAgreement over WarrantyAgreementModel {
46+
clause validateClaim(request : WarrantyClaimRequest) : ClaimValidationResponse {
47+
48+
let claimDate = request.claimDate;
49+
let purchaseDate = contract.purchaseDate;
50+
let warrantyPeriod = Duration{ amount: 1, unit: ~org.accordproject.time.TemporalUnit.years };
51+
52+
enforce isAfter(claimDate, purchaseDate) else
53+
throw ErgoErrorResponse{ message : "Claim date is before the purchase date." }
54+
;
55+
56+
let isValid =
57+
if isBefore(claimDate, addDuration(purchaseDate, warrantyPeriod))
58+
then VALID_CLAIM
59+
else EXPIRED_CLAIM
60+
;
61+
return ClaimValidationResponse{
62+
status : isValid,
63+
client : contract.client,
64+
warrantyDetails : contract.warrantyDetails
65+
}
66+
}
67+
}
68+
```
69+
70+
This logic ensures that a warranty claim is only accepted if it falls within the warranty period. It checks if the claim date is after the purchase date and within the warranty duration, returning a validation response accordingly.
71+
72+
## Summary
73+
74+
In this module, we've explored Template Logic and how it enables your templates to perform computations and enforce rules dynamically. By embedding logic into your templates, you can create more interactive and responsive documents that adapt to different data inputs and scenarios.
75+
76+
## Share Your Work
77+
78+
Once you’ve finished editing or using a template, you can easily share your work with others. Simply click the **Share** button to generate a shareable link. This allows you to collaborate with others or distribute your completed templates efficiently.

0 commit comments

Comments
 (0)