Skip to content

Commit 5423e84

Browse files
committed
Minor docs improvements
1 parent 6e31988 commit 5423e84

3 files changed

Lines changed: 17 additions & 14 deletions

File tree

ZptSharp.Documentation/articles/WhatIsZptSharp.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# What is ZptSharp?
22

33
ZptSharp is an open source [library for .NET] for writing HTML or XML documents based upon page templates.
4-
It is useable as a library, and packages are available for use:
4+
It may be used in your own applications as a library.
5+
Packages are also available to use ZptSharp:
56

6-
* As an ASP.NET/ASP.NET Core MVC **View Engine**
7+
* As a **View Engine** for AS<span>P.N</span>ET MVC5 or AS<span>P.N</span>ET Core MVC
78
* As a standalone command-line application
89

910
ZptSharp is based upon the *Zope Page Templates* specification & syntax.
@@ -16,7 +17,7 @@ ZptSharp is a pure .NET implementation of just the page templates syntax from Zo
1617

1718
## What is the syntax?
1819

19-
ZPT is *an attribute language* designed specifically for use with HTML and/or XML documents. All of the ZPT directives are placed in **attributes**.
20+
ZPT is *an attribute language* designed specifically for use with HTML and/or XML documents. All of the ZPT directives are written using **attributes**.
2021

2122
ZPT syntax:
2223

@@ -30,17 +31,17 @@ ZPT syntax:
3031

3132
ZPT's syntax is organised into three logical 'modules' of functionality.
3233
The first of these is an extensible expression syntax for accessing the model, which has the goal of being easy to read & understand without programming knowledge.
33-
The default syntax looks a lot like a URL path, such as `here/Product/Name`.
34+
Most expressions will look a lot like a URL path, such as `here/Product/Name`.
3435
This expression syntax is named **TALES**.
3536

3637
The second is a mechanism (named **METAL**) for reusing markup across document templates and authoring logical parts of a document as separate source files.
3738
Designers define *macros* of markup for re-use, which may optionally contain *slots* (placeholders).
3839
At the point of macro usage, markup/content may be supplied to fill the available slots.
3940

40-
The third function of ZPT handles the actual data-binding and manipulation of the document using the model; this a syntax named **TAL**.
41-
Some aspects of that functionality include (but are not limited to):
41+
The third function of ZPT handles the actual data-binding and manipulation of the document using the model; this is a syntax named **TAL**.
42+
Some aspects of that functionality include the following, although this is not a comprehensive list of its capabilities.
4243

4344
* Writing model content to the document
4445
* Conditionally removing parts of the document
4546
* Repeating parts of the document for items in a collection
46-
* Adding/removing/updating attributes & values
47+
* Adding/removing/updating attributes & values

ZptSharp.Documentation/articles/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
## Get started
44

5-
Those who are new to ZptSharp are recommended to follow one of four short **quick start** guides. These guides each take the developer through a 'hello world' example, giving them a working sample app using ZptSharp. You may also wish to read [a conceptual summary] of what ZptSharp is.
5+
Those who are new to ZptSharp are recommended to follow one of four short **quick start** guides.
6+
These guides each take the developer through a 'hello world' example, giving them a working sample app using ZptSharp.
7+
It is also recommended to read [the short conceptual summary of ZptSharp], which illustrates its fundamental principles.
68

79
* [Quick start for ASP.NET Core MVC]
810
* [Quick start for ASP.NET MVC 5]
@@ -11,7 +13,7 @@ Those who are new to ZptSharp are recommended to follow one of four short **quic
1113

1214
An ideal follow-up to using a quick start guide is to follow [the ZPT tutorial]. This expands upon what was learned during quick-start teaches the full range of ZptSharp functionality.
1315

14-
[a conceptual summary]: WhatIsZptSharp.md
16+
[the short conceptual summary of ZptSharp]: WhatIsZptSharp.md
1517
[Quick start for ASP.NET MVC 5]: QuickStart/Mvc5.md
1618
[Quick start for ASP.NET Core MVC]: QuickStart/MvcCore.md
1719
[Quick start for the command line renderer]: QuickStart/CliApp.md

ZptSharp.Documentation/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Intuitive HTML & XML document templates for .NET
44

5-
ZptSharp is a document template language & renderer for .NET Framework, .NET Core & .NET 5+.
5+
ZptSharp is a document template language & renderer for .NET.
66
It may be used as a **View Engine** for AS<span>P.N</span>ET MVC5 or AS<span>P.N</span>ET Core MVC.
77
It also comes with a command-line rendering tool and may be consumed by your own applications as an API.
88

@@ -25,8 +25,8 @@ It also comes with a command-line rendering tool and may be consumed by your own
2525

2626
## Get started
2727

28-
Here are some recommended first steps to get learning about ZptSharp and the ZPT syntax.
29-
You may also visit [the documentation home page] for more links & info.
28+
Here are some recommended first steps to learn about ZptSharp and the ZPT syntax.
29+
[The documentation home page] contains more links & reference.
3030

3131
* [What is ZptSharp?]
3232
* Quick start
@@ -42,8 +42,8 @@ You may also visit [the documentation home page] for more links & info.
4242
[Command line renderer]: articles/QuickStart/CliApp.md
4343
[Consume the API]: articles/QuickStart/ConsumingTheApi.md
4444
[ZPT tutorial]: articles/ZptTutorial/index.md
45-
[the documentation home page]: articles/index.md
45+
[The documentation home page]: articles/index.md
4646

4747
</section>
4848

49-
</div>
49+
</div>

0 commit comments

Comments
 (0)