From 64423b13a639799a1467df2d1b0481e717954904 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Mon, 30 Jul 2018 17:16:10 -0700 Subject: [PATCH] README, docs - Tweak titles --- ext/afform/README.md | 4 ++-- ext/afform/docs/angular.md | 2 +- ext/afform/docs/crud.md | 2 +- ext/afform/docs/embed.md | 4 ++-- ext/afform/docs/quickstart.md | 2 +- ext/afform/docs/writing.md | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/ext/afform/README.md b/ext/afform/README.md index be92e3aec5..b2505d5935 100644 --- a/ext/afform/README.md +++ b/ext/afform/README.md @@ -46,8 +46,8 @@ cv en afform ## Development * [Quick Start: Creating the canonical definition of a basic form](docs/quickstart.md) -* [Writing: Forms as basic AngularJS templates](docs/writing.md) (With example: *Contact Record*) -* [Embedding: Forms as reusable building-block](docs/embed.md) (With example: *Contact Record*) +* [Writing Forms: Afform as basic AngularJS templates](docs/writing.md) (With example: *Contact Record*) +* [Embedding Forms: Afform as reusable building-block](docs/embed.md) (With example: *Contact Record*) * [Form CRUD: Updating forms via programmatic API](docs/crud.md) * [Full AngularJS: Integrating between Afform and vanilla AngularJS](docs/angular.md) * [Roadmap and Known Issues](docs/roadmap.md) diff --git a/ext/afform/docs/angular.md b/ext/afform/docs/angular.md index 0224049603..e63a354a8a 100644 --- a/ext/afform/docs/angular.md +++ b/ext/afform/docs/angular.md @@ -1,4 +1,4 @@ -## Development: Full AngularJS +# Full AngularJS: Integrating between Afform and vanilla AngularJS Afform is a subset of AngularJS -- it emphasizes the use of *directives* as a way to *choose and arrange* the parts of your form. There is more to AngularJS -- such as client-side routing, controllers, services, etc. What to do if you diff --git a/ext/afform/docs/crud.md b/ext/afform/docs/crud.md index e1f424b3ab..24f6d823aa 100644 --- a/ext/afform/docs/crud.md +++ b/ext/afform/docs/crud.md @@ -1,4 +1,4 @@ -## Development: Form CRUD API +# Form CRUD: Updating forms via programmatic API Now that we've defined a baseline form, it's possible for administrators and GUI applications to inspect the form using the API: diff --git a/ext/afform/docs/embed.md b/ext/afform/docs/embed.md index c6708ad5eb..df63184093 100644 --- a/ext/afform/docs/embed.md +++ b/ext/afform/docs/embed.md @@ -1,4 +1,4 @@ -## Development: Embedding forms +# Embedding Forms: Afform as reusable building-block In the [quick-start example](quickstart.md), we registered a new route (`"server_route": "civicrm/hello-world"`) -- this created a simple, standalone page with the sole purpose of displaying the `helloworld` form. What if we want to embed the form @@ -23,7 +23,7 @@ Now, in `afform/helloworld/layout.html`, you can use `options.phaseOfMoon`: Hello, {{routeParams.name}}. The moon is currently {{options.phaseOfMoon}}. ``` -## Development: Embedding forms: Contact record example +## Example: Contact record Is this useful? Let's suppose you're building a contact record page. diff --git a/ext/afform/docs/quickstart.md b/ext/afform/docs/quickstart.md index 4e6b0beefb..d3c47063a1 100644 --- a/ext/afform/docs/quickstart.md +++ b/ext/afform/docs/quickstart.md @@ -1,4 +1,4 @@ -## Development: Quick Start +# Quick Start: Creating the canonical definition of a basic form As an extension author, you can define a form along with its default, canonical content. Simply create a folder named `afform/`. In diff --git a/ext/afform/docs/writing.md b/ext/afform/docs/writing.md index 6fb9a3986b..cd4bf7f870 100644 --- a/ext/afform/docs/writing.md +++ b/ext/afform/docs/writing.md @@ -1,4 +1,4 @@ -## Development: Writing HTML templates +# [Writing Forms: Afform as basic AngularJS templates In AngularJS, the primary language for orchestrating a screen is HTML. You can do interesting things in Angular HTML, such as displaying variables and applying directives. @@ -20,7 +20,7 @@ Additionally, AngularJS allows *directives* -- these are extra HTML attributes w A full explanation of these features is out-of-scope for this document, but the key point is that you can use standard AngularJS markup. -## Development: Writing HTML templates: Contact record example +## Example: Contact record Let's say we want `helloworld` to become a basic "View Contact" page. A user would request a URL like: -- 2.25.1