Skip to content

Commit e79afdc

Browse files
committed
2 parents c58b850 + a493b1a commit e79afdc

File tree

4 files changed

+12
-15
lines changed

4 files changed

+12
-15
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,15 @@ We recommend using [Eclipse](https://eclipse.org), the built-in WikiText editor
7373

7474
Read the [OpenFastTrace User Guide](https://github.com/itsallcode/openfasttrace/blob/master/doc/user_guide.md) to learn how to create specifications in the OFT Markdown format.
7575

76-
### Document Title and Authors
76+
### Stripping the OFT Comments
7777

78-
Start the
78+
The template contains a lot of comments in the form of Markdown quotes starting with "OFT:". You can strip them with your editors multi-file search and replace function (e.g. CRTL+H in Eclipse).
79+
80+
Or you can use command line tools like `sed`. Run the script below on the root directory of the architecture template.
81+
82+
```bash
83+
find src/doc -name '*.md' -exec sed -i -e '/^>\s*OFT:.*/d' {} \;
84+
```
7985

8086
## Building
8187

@@ -181,4 +187,4 @@ Check the links in the generated HTML docuements:
181187
linkchecker --check-extern target/*.html
182188
```
183189

184-
If you remove the command line switch `--check-extern` only local links are checked.
190+
If you remove the command line switch `--check-extern` only local links are checked.

pom.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
runtime_view/paying_with_credit_card.md deployment_view.md
2727
concepts.md design_decisions.md quality_scenarios.md risks.md
2828
glossary.md bibliography.md</spec.files>
29+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2930
<!-- Do not change the properties below -->
3031
<spec.source.directory>${project.basedir}/src/doc</spec.source.directory>
3132
<spec.source.css.directory>${spec.source.directory}/css</spec.source.css.directory>
@@ -190,4 +191,4 @@
190191
</plugin>
191192
</plugins>
192193
</build>
193-
</project>
194+
</project>

src/doc/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The target audience are persons involved with the construction of the system, te
2727

2828
### Notational Conventions
2929

30-
Requirements in this document are written in "Requirment enhanced Markdown format" which is the native specification format of [OpenFastTrace (OFT)](https://github.com/itsallcode/openfasttrace). If you want to learn more about this format please check the [OpenFastTrace User Guide](https://github.com/itsallcode/openfasttrace/blob/master/doc/user_guide.md).
30+
Requirements in this document are written in "Requirement enhanced Markdown format" which is the native specification format of [OpenFastTrace (OFT)](https://github.com/itsallcode/openfasttrace). If you want to learn more about this format please check the [OpenFastTrace User Guide](https://github.com/itsallcode/openfasttrace/blob/master/doc/user_guide.md).
3131

3232
Using this format allows you to scan the requirement chain using OFT to see if all requirements from the user-level [System Requirement Specification (SRS)](bibliography.md#srs) are covered.
3333

src/doc/runtime_view/concepts.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)