platform/packages/jael/jael/README.md

# Jael 3

![Pub Version (including pre-releases)](https://img.shields.io/pub/v/jael3?include_prereleases)
[![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)
[![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion)
[![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/tree/master/packages/jael/jael/LICENSE)

A simple server-side HTML templating engine for Dart.

[See documentation.](https://angel3-docs.dukefirehawk.com/packages/front-end/jael)

## Installation

In your `pubspec.yaml`:

```yaml
dependencies:
  jael3: ^4.2.0
```

## API

The core `jael3` package exports classes for parsing Jael templates, an AST library, and a `Renderer` class that generates HTML on-the-fly.

```dart
import 'package:belatuk_code_buffer/belatuk_code_buffer.dart';
import 'package:belatuk_symbol_table/belatuk_symbol_table.dart';
import 'package:jael3/jael3.dart' as jael;

void myFunction() {
    const template = '''
<html>
  <body>
    <h1>Hello</h1>
    <img src=profile['avatar']>
  </body>
</html>
''';

    var buf = CodeBuffer();
    var document = jael.parseDocument(template, sourceUrl: 'test.jael', asDSX: false);
    var scope = SymbolTable(values: {
      'profile': {
        'avatar': 'thosakwe.png',
      }
    });

    const jael.Renderer().render(document, buf, scope);
    print(buf);
}
```

Pre-processing (i.e. handling of blocks and includes) is handled by `package:jael3_preprocessor.`.
Updated Jael to use belatuk_symbol_table 2021-09-13 00:30:02 +00:00			`# Jael 3`

Updated linter to package:lints 2021-09-25 06:32:32 +00:00			`![Pub Version (including pre-releases)](https://img.shields.io/pub/v/jael3?include_prereleases)`
Migrated jael to jael2 2021-05-15 09:38:15 +00:00			`[![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)`
			`[![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion)`
Updated linter to package:lints 2021-09-25 06:32:32 +00:00			`[![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/tree/master/packages/jael/jael/LICENSE)`
core nearly done 2017-09-29 22:39:37 +00:00
			`A simple server-side HTML templating engine for Dart.`

Updated linter to package:lints 2021-09-25 06:32:32 +00:00			`[See documentation.](https://angel3-docs.dukefirehawk.com/packages/front-end/jael)`
core nearly done 2017-09-29 22:39:37 +00:00
Updated Jael to use belatuk_symbol_table 2021-09-13 00:30:02 +00:00			`## Installation`

core nearly done 2017-09-29 22:39:37 +00:00			In your `pubspec.yaml`:

			```yaml
			`dependencies:`
Updated linter to package:lints 2021-09-25 06:32:32 +00:00			`jael3: ^4.2.0`
core nearly done 2017-09-29 22:39:37 +00:00			```

Updated Jael to use belatuk_symbol_table 2021-09-13 00:30:02 +00:00			`## API`

			The core `jael3` package exports classes for parsing Jael templates, an AST library, and a `Renderer` class that generates HTML on-the-fly.
core nearly done 2017-09-29 22:39:37 +00:00
			```dart
Updated JAEL 2021-12-30 01:44:26 +00:00			`import 'package:belatuk_code_buffer/belatuk_code_buffer.dart';`
			`import 'package:belatuk_symbol_table/belatuk_symbol_table.dart';`
			`import 'package:jael3/jael3.dart' as jael;`
core nearly done 2017-09-29 22:39:37 +00:00
			`void myFunction() {`
			`const template = '''`
			`<html>`
			`<body>`
			`<h1>Hello</h1>`
			`<img src=profile['avatar']>`
			`</body>`
			`</html>`
			`''';`

Apply pedantic 2019-07-29 22:12:52 +00:00			`var buf = CodeBuffer();`
Jael formatter + 2.0.2 2019-07-29 22:01:24 +00:00			`var document = jael.parseDocument(template, sourceUrl: 'test.jael', asDSX: false);`
Apply pedantic 2019-07-29 22:12:52 +00:00			`var scope = SymbolTable(values: {`
core nearly done 2017-09-29 22:39:37 +00:00			`'profile': {`
			`'avatar': 'thosakwe.png',`
			`}`
			`});`

			`const jael.Renderer().render(document, buf, scope);`
			`print(buf);`
			`}`
			```

Updated linter to package:lints 2021-09-25 06:32:32 +00:00			Pre-processing (i.e. handling of blocks and includes) is handled by `package:jael3_preprocessor.`.