fix many mistakes in the documentation

AmpersandTarski · Aug 10, 2023 · 83ab064 · 83ab064
1 parent 44fddff
commit 83ab064
Show file tree

Hide file tree

Showing 16 changed files with 896 additions and 160 deletions.
diff --git a/Ampersand.archimate b/Ampersand.archimate
diff --git a/docs/Examples.md b/docs/Examples.md
@@ -56,7 +56,7 @@ because it is familiar. We show this example to demonstrate how to get different
 
 ## Preliminaries
 
-The compiler uses templates to adapt an interface to specific needs regarding its HTML structure. Please read the [documentation of templates](https://github.com/AmpersandTarski/prototype/tree/master/templates) first for details.
+The compiler uses templates to adapt an interface to specific needs regarding its HTML structure. Please read the [documentation of templates](../../../prototype/tree/master/templates) first for details.
 
 To link system activities to a person or organisation, we use the notion of `Account`. To log in means to associate a session with the `Account` of the user. This association is made in the relation `sessionAccount`. To log out means to break that link, i.e. to remove the session/account pair from relation `sessionAccount`. When logging in, it is customary that the user identifies herself. In this example we do this with a `UserID` and `Password`.
 
@@ -156,7 +156,7 @@ subbox remains empty. However, when logged in, the other subbox remains empty:
 ## Example {#example-service-structure}
 To understand the structure of a service (keyword: `INTERFACE`), this section introduces a small example of a user interface, which shows the name, status, e-mail and co-workers of a person called "J. Lovell".
 
-![Example of a user interface](./Figures/InterfaceLovellRaw.jpg)
+![Example of a user interface](./assets/InterfaceLovellRaw.jpg)
 
 The specification of this user interface is given in the following service definition:
 

diff --git a/.../Figures/InterfaceAlphaBoardFormatted.jpg → docs/assets/InterfaceAlphaBoardFormatted.jpg b/.../Figures/InterfaceAlphaBoardFormatted.jpg → docs/assets/InterfaceAlphaBoardFormatted.jpg
diff --git a/docs/assets/InterfaceAlphaBoardNested.jpg b/docs/assets/InterfaceAlphaBoardNested.jpg
diff --git a/...Figures/InterfaceAlphaBoardNestedCRUD.jpg → .../assets/InterfaceAlphaBoardNestedCRUD.jpg b/...Figures/InterfaceAlphaBoardNestedCRUD.jpg → .../assets/InterfaceAlphaBoardNestedCRUD.jpg
diff --git a/docs/Figures/InterfaceLovellEditable.jpg → docs/assets/InterfaceLovellEditable.jpg b/docs/Figures/InterfaceLovellEditable.jpg → docs/assets/InterfaceLovellEditable.jpg
diff --git a/docs/Figures/InterfaceLovellRaw.jpg → docs/assets/InterfaceLovellRaw.jpg b/docs/Figures/InterfaceLovellRaw.jpg → docs/assets/InterfaceLovellRaw.jpg
diff --git a/docs/Figures/InterfaceLovellTabsCRUD.png → docs/assets/InterfaceLovellTabsCRUD.png b/docs/Figures/InterfaceLovellTabsCRUD.png → docs/assets/InterfaceLovellTabsCRUD.png
diff --git a/docs/reference-material/The-language-Ampersand.md b/docs/reference-material/The-language-Ampersand.md
@@ -104,13 +104,13 @@ When running an application in your browser, you are watching one user interface
 
 Further examples:
 
-* a [client service](./Examples.md#services-example-client) to allow clients of a web shop to change their name and address and show them status information of their orders;
-* a [login service](./Examples.md#services-example-login) to demonstrate how to get different interface structures under varying conditions.
+* a [client service](../Examples.md#services-example-client) to allow clients of a web shop to change their name and address and show them status information of their orders;
+* a [login service](../Examples.md#services-example-login) to demonstrate how to get different interface structures under varying conditions.
 
 ### CRUD annotations {#crud}
 CRUD annotations are used in services to constrain the functionality of fields and boxes in an `INTERFACE`-statement. This allows you to minimize the functionality for your users, to design for easy learning.
 
-Each CRUD annotation comes right after a [term](../terms/README.md), so we can always refer to "the term" to which a CRUD annotation belongs. A CRUD annotation constrains the things your user can do with the target atoms and the pairs of its term.
+Each CRUD annotation comes right after a [term](./the-language-ampersand/terms/README.md), so we can always refer to "the term" to which a CRUD annotation belongs. A CRUD annotation constrains the things your user can do with the target atoms and the pairs of its term.
 
 The CRUD-annotation specifies Create, Read, Update, and Delete rights for the term it follows. Capital = allowed, Non-capital = not allowed. CRUD is the default, so if you specify nothing, everything is allowed. The following service definition illustrates this.
 
@@ -238,7 +238,7 @@ BOX <FORM>
      ]
 ```
 
-This service shows three rows in the user interface, **Students**, **Course** and **Modules**. The first column shows students in each of its rows. Each student is shown in the column layout. The second row shows courses in two columns, **Course** and **Modules**. Please read about [templates](https://github.com/AmpersandTarski/prototype/tree/master/templates) if you are curious which other ways of displaying information there are besides `BOX <FORM>`.  Please read the [explanation of CRUD annotations](../crud.md) if you are curious about the CRUD annotations. This is what the user will see on the screen.
+This service shows three rows in the user interface, **Students**, **Course** and **Modules**. The first column shows students in each of its rows. Each student is shown in the column layout. The second row shows courses in two columns, **Course** and **Modules**. Please read about [templates](../../../prototype/tree/master/templates) if you are curious which other ways of displaying information there are besides `BOX <FORM>`.  Please read the [explanation of CRUD annotations](./the-language-ampersand/services.md#CRUD) if you are curious about the CRUD annotations. This is what the user will see on the screen.
 
 ![Row-oriented layout of a user interface with columns in each row](<../assets/ROWS layout example.png>)
 
@@ -275,8 +275,8 @@ This service shows three tabs in the user interface, **Students**, **Course** an
 
 We have discussed the `COLS`, `ROWS`, and `TABS` layout options. Please note that these options do not change the semantics; whatever your options, Ampersand displays the same data in the same fields.
 
-If these options are not enough, you can [enhance your application with your own layouts](your-own-widgets-html-and-css.md).
+If these options are not enough, you can [enhance your application with your own layouts](../tutorial/services.md#layout-and-widgets).
 
 #### Your own widgets \(HTML and CSS\)
-You don't have to put up with the [Ampersand built-in layout options](https://github.com/AmpersandTarski/prototype/tree/master/templates) if they don't suit your purpose. You can change most anything by including your own code snippets.  \(to be done...\). 
+You don't have to put up with the [Ampersand built-in layout options](../../../prototype/tree/master/templates) if they don't suit your purpose. You can change most anything by including your own code snippets.  \(to be done...\). 
 
diff --git a/docs/reference-material/syntax-of-ampersand.md b/docs/reference-material/syntax-of-ampersand.md
@@ -6,7 +6,7 @@ id: syntax-of-ampersand
 
 This page is about the syntax of ampersand scripts. 
 
-## The CONCEPT statement
+## The CONCEPT statement 
 
 ### Purpose:
 

diff --git a/docs/reference-material/the-language-ampersand/current-date.md b/docs/reference-material/the-language-ampersand/current-date.md
@@ -23,7 +23,7 @@ ENDCONTEXT
 
 If you run this program, this is what you'll see
 
-![](../../assets/image.png)
+<!-- ![](../../assets/image.png) -->
 
 ### Explanation
 

diff --git a/docs/reference-material/the-language-ampersand/how-to-read-syntax-statements.md b/docs/reference-material/the-language-ampersand/how-to-read-syntax-statements.md
@@ -95,7 +95,7 @@ Keywords in Ampersand are always written in CAPITALS.
   * `HTML`
   * `LATEX`
   * `MARKDOWN`
-* Keywords for [services](../../The-language-Ampersand.md#syntax-of-interface-statements)
+* Keywords for [services](./services.md#syntax-of-interface-statements)
   * `INTERFACE`
   * `FOR`
   * `LINKTO`