Skip to content

Commit

Permalink
Doc cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbrowndotje committed Jul 2, 2024
1 parent 2a263a9 commit 3a1c3f2
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 4 deletions.
4 changes: 3 additions & 1 deletion dsl/09-workspace-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ permalink: /dsl/workspace-extension

# Workspace extension

...
...

See [DSL Cookbook - Workspace extension](/dsl/cookbook/workspace-extension/) for more.
2 changes: 1 addition & 1 deletion dsl/13-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ permalink: /dsl/plugins

# Plugins

Plugins can be used where more control or customisation is required, and provide access to the workspace via the [Structurizr for Java library](https://github.com/structurizr/java). For example, you could use a plugin to create model elements based upon an external data source, or perhaps define views programmatically. Plugins can be used at any point in the DSL.
Plugins can be used where more control or customisation is required, and provide access to the workspace via the [Structurizr for Java library](/java). For example, you could use a plugin to create model elements based upon an external data source, or perhaps define views programmatically. Plugins can be used at any point in the DSL.

To write a plugin, create a Java class that implements the `com.structurizr.dsl.StructurizrDslPlugin` interface (you will need to add a dependency on the DSL library, which can be found on Maven Central via `com.structurizr:structurizr-dsl`).

Expand Down
45 changes: 43 additions & 2 deletions dsl/14-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -1147,6 +1147,16 @@ users {
}
```

## !include

The `!include` keyword can be used to include DSL fragments from another file.

```
!include <file|directory|url>
```

See [Includes](/dsl/includes) for more details.

## !identifiers

The `!identifiers` keyword can be used to modify the scope of identifiers.
Expand All @@ -1157,6 +1167,16 @@ The `!identifiers` keyword can be used to modify the scope of identifiers.

See [Identifiers](/dsl/identifiers) for more details.

## !impliedRelationships

The `!impliedRelationships` keyword can be used to configure how implied relationships are created.

```
!impliedRelationships <true|false|fqcn>
```

See [Implied relationships](/dsl/implied-relationships) for more details.

## !docs

The `!docs` keyword can be used to attach Markdown/AsciiDoc documentation to the parent context (either the workspace, a software system, or a container).
Expand All @@ -1165,7 +1185,7 @@ The `!docs` keyword can be used to attach Markdown/AsciiDoc documentation to the
!docs <path> [fully qualified class name]
```

See [Documentation](docs.html) for more details.
See [Documentation](/dsl/docs) for more details.

## !adrs

Expand All @@ -1175,4 +1195,25 @@ The `!adrs` keyword can be used to attach Markdown/AsciiDoc ADRs to the parent c
!adrs <path> [fully qualified class name]
```

See [Architecture decision records](adrs.html) for more details.
See [Architecture decision records](/dsl/adrs) for more details.

## !script

The `!script` keyword can be used to run inline or external scripts in a number of JVM compatible languages.

```
!script <groovy|kotlin|ruby|javascript>
!script <file>
```

See [Scripts](/dsl/scripts) for more details.

## !plugin

The `!plugin` keyword can be used to run Java plugins.

```
!plugin <fqcn>
```

See [Plugins](/dsl/plugins) for more details.

0 comments on commit 3a1c3f2

Please sign in to comment.