Commit c29d15b2 authored by Dennis Hendriks's avatar Dennis Hendriks
Browse files

#73 SeText docs: removing obsolete files, updated index/attribute files.

parent 3aba9c89
......@@ -16,12 +16,12 @@
// Defining an alternative 'imgsdir' attribute avoids this problem and images will be visible in the preview.
// For specific parts of the documentation, we introduce an additional attribute, to allow shorter relative paths.
// Changes to attributes require a restart of Eclipse to become effective in the asciidoc editor.
ifndef::imgsdir[:ref-imgsdir: ../images/reference-manual]
ifdef::imgsdir[:ref-imgsdir: {imgsdir}/reference-manual]
ifndef::imgsdir[:setext-imgsdir: ../images/setext]
ifdef::imgsdir[:setext-imgsdir: {imgsdir}/setext]
// Defining a unique prefix for all sections in this part of the documentation to avoid duplication of reference ids.
// Note that this only works for section ids and not for figures, tables, etc. (and there is no alternative attribute for this).
:idprefix: ref-
:idprefix: setext-
:idseparator: -
:listing-caption: Listing
......
/////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, 2021 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the terms
// of the MIT License which is available at https://opensource.org/licenses/MIT
//
// SPDX-License-Identifier: MIT
/////////////////////////////////////////////////////////////////////////////////
// Common attributes to set for all documents within this directory.
// Note that we do not use the official 'imagesdir' attribute of asciidoc as there seems to be a bug in the asciidoc editor within our development environment.
// Defining an alternative 'imgsdir' attribute avoids this problem and images will be visible in the preview.
// Changes to attributes require a restart of Eclipse to become effective in the asciidoc editor.
ifndef::imgsdir[:imgsdir: ../images]
:idprefix:
:idseparator: -
:listing-caption: Listing
:chapter-label:
// Enable Science, Technology, Engineering and Math (STEM) expressions in the browser.
:stem:
// Enable experimental features, for 'kbd' macro.
:experimental:
// Admonition symbols (e.g. 'warning' symbol).
:icons: font
// Disable default footer.
:nofooter:
<!--
Copyright (c) 2010, 2021 Contributors to the Eclipse Foundation
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.
This program and the accompanying materials are made available under the terms
of the MIT License which is available at https://opensource.org/licenses/MIT
SPDX-License-Identifier: MIT
-->
<div id="footer">
<div id="footer-text">
<a href="https://www.eclipse.org">Eclipse Home</a>
|
<a href="https://www.eclipse.org/legal/privacy.php">Privacy Policy</a>
|
<a href="https://www.eclipse.org/legal/termsofuse.php">Terms of Use</a>
|
<a href="https://www.eclipse.org/legal/copyright.php">Copyright Agent</a>
|
<a href="https://www.eclipse.org/legal">Eclipse Legal</a>
</div>
</div>
<!--
Copyright (c) 2010, 2021 Contributors to the Eclipse Foundation
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.
This program and the accompanying materials are made available under the terms
of the MIT License which is available at https://opensource.org/licenses/MIT
SPDX-License-Identifier: MIT
-->
<style>
.menu, .submenu, .menuitem, .menuref {
background-color: Menu;
}
.button {
border: 1px solid ButtonFace;
/*
Styling too similar to a real button is considered bad practice, see https://github.com/asciidoctor/asciidoctor/issues/1881#issuecomment-250702085
border: 2px outset ButtonFace;
background-color: ButtonFace;
*/
padding-left: 0.5ex;
padding-right: 0.5ex;
font-weight: normal;
font-family: "Segoe UI","Open Sans","DejaVu Sans",sans-serif;
white-space: nowrap;
}
.button:before {
content: none !important;
}
.button:after {
content: none !important;
}
#footer-text, #footer-text a {
color: rgba(255,255,255,.8)
}
.toc-cur-page {
font-weight: bold;
}
</style>
......@@ -10,88 +10,31 @@
// SPDX-License-Identifier: MIT
/////////////////////////////////////////////////////////////////////////////////
// Including common attributes to set for all documents within this directory.
include::_root_attributes.asciidoc[]
include::_part_attributes.asciidoc[]
// Enable custom style in index-docinfo.html.
:docinfo: private
// Use this for asciidoc documents containing a title.
:doctype: book
= SeText documentation (Incubation)
:author: Copyright (c) 2010, 2021 Contributors to the Eclipse Foundation
:title-logo-image: {imgsdir}/eclipse-incubation.png
[[setext-chapter-index]]
== SeText scanner/parser generator
SeText is a textual syntax specification language and associated scanner/parser generator.
It can be used to specify the syntax of a language, and automatically generate a scanner and LALR(1) parser(s).
SeText is one of the tools of the Eclipse ESCET(TM) project.
Visit the link:https://eclipse.org/escet[project website] for downloads, installation instructions, source code, general tool usage information, information on how to contribute, and more.
[WARNING]
====
The Eclipse ESCET project, including the SeText language and toolset, is currently in the link:https://wiki.eclipse.org/Development_Resources/Process_Guidelines/What_is_Incubation[Incubation Phase].
For the purpose of this documentation, it is assumed that the reader:
image:{imgsdir}/eclipse-incubation.png[,width=300,pdfwidth=45%]
====
* Is familiar with scanner/parser generators (for example _yacc_/_bison_ and _lex_/_flex_).
* Is familiar with scanner and LALR(1) parser technology, including regular expressions and BNF notation.
* Understands the limitations of the LALR(1) algorithm.
For the purpose of this document, it is assumed that the reader is familiar with scanner/parser generators (for example _yacc_/_bison_ and _lex_/_flex_), scanner and LALR(1) parser technology (including regular expressions and BNF notation), and understands the limitations of the LALR(1) algorithm.
The following topics explain the SeText language and tools in more detail:
ifdef::website-output[]
TIP: You can link:eclipse-escet-incubation-setext-manual.pdf[download this manual] as a PDF as well.
endif::website-output[]
The following topics are discussed:
* <<setext-reference-manual>>
* <<setext-lexical-syntax>>
* <<setext-specifying-lexical-syntax>>
* <<setext-regular-expressions>>
* <<setext-terminal-descriptions>>
* <<setext-imports>>
* <<setext-scanner-hooks>>
* <<setext-specifying-grammars>>
* <<setext-parser-hooks>>
* <<setext-usage-hints>>
* <<setext-generated-scanners-parsers>>
* <<setext-using-in-an-eclipse-plugin-project>>
* <<setext-limitations>>
* <<setext-release-notes,SeText release notes>>
* <<setext-legal,Legal information>>
// Reference manual
include::reference-manual/index.asciidoc[]
:leveloffset: +1
include::reference-manual/lexical-syntax.asciidoc[]
include::reference-manual/specifying-lexical-syntax.asciidoc[]
include::reference-manual/regular-expressions.asciidoc[]
include::reference-manual/terminal-descriptions.asciidoc[]
include::reference-manual/imports.asciidoc[]
include::reference-manual/scanner-hooks.asciidoc[]
include::reference-manual/specifying-grammars.asciidoc[]
include::reference-manual/parser-hooks.asciidoc[]
include::reference-manual/usage-hints.asciidoc[]
include::reference-manual/generated-scanners-parsers.asciidoc[]
:leveloffset: -1
// Using SeText in an Eclipse Plug-in Project
include::using-in-an-eclipse-plugin-project.asciidoc[]
// Limitations
include::limitations.asciidoc[]
// Release notes
include::release-notes.asciidoc[]
// Legal
include::legal.asciidoc[]
/////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, 2021 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the terms
// of the MIT License which is available at https://opensource.org/licenses/MIT
//
// SPDX-License-Identifier: MIT
/////////////////////////////////////////////////////////////////////////////////
include::_root_attributes.asciidoc[]
[[setext-legal]]
== Legal
The material in this documentation is Copyright (c) 2010, 2021 Contributors to the Eclipse Foundation.
Eclipse ESCET and ESCET are trademarks of the Eclipse Foundation.
Eclipse, and the Eclipse Logo are registered trademarks of the Eclipse Foundation.
Other names may be trademarks of their respective owners.
*License*
The Eclipse Foundation makes available all content in this document ("Content").
Unless otherwise indicated below, the Content is provided to you under the terms and conditions of the MIT License.
A copy of the MIT License is available at link:https://opensource.org/licenses/MIT[].
For purposes of the MIT License, "Software" will mean the Content.
If you did not receive this Content directly from the Eclipse Foundation, the Content is being redistributed by another party ("Redistributor") and different terms and conditions may apply to your use of any object code in the Content.
Check the Redistributor's license that was provided with the Content.
If no such license exists, contact the Redistributor.
Unless otherwise indicated below, the terms and conditions of the MIT License still apply to any source code in the Content and such source code may be obtained at link:http://www.eclipse.org[].
/////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, 2021 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the terms
// of the MIT License which is available at https://opensource.org/licenses/MIT
//
// SPDX-License-Identifier: MIT
/////////////////////////////////////////////////////////////////////////////////
include::_part_attributes.asciidoc[]
[[setext-reference-manual]]
== SeText Reference Manual
This manual explains the SeText language.
Topics discussed here are:
* <<setext-lexical-syntax>>
* <<setext-specifying-lexical-syntax>>
* <<setext-regular-expressions>>
* <<setext-terminal-descriptions>>
* <<setext-imports>>
* <<setext-scanner-hooks>>
* <<setext-specifying-grammars>>
* <<setext-parser-hooks>>
* <<setext-usage-hints>>
* <<setext-generated-scanners-parsers>>
/////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, 2021 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the terms
// of the MIT License which is available at https://opensource.org/licenses/MIT
//
// SPDX-License-Identifier: MIT
/////////////////////////////////////////////////////////////////////////////////
include::_root_attributes.asciidoc[]
[[setext-release-notes]]
== SeText release notes
The release notes for the versions of SeText and the associated tools, as part of the Eclipse ESCET project, are listed below in reverse chronological order.
The release notes may refer to issues, the details for which can be found at the Eclipse ESCET link:https://gitlab.eclipse.org/eclipse/escet/escet/-/issues[GitLab issues page].
See also the Eclipse ESCET link:https://eclipse.org/escet/escet/release-notes.html[toolkit release notes] covering those aspects that are common to the various Eclipse ESCET tools.
=== Version 0.4
TBD
=== Version 0.3
Improvements and fixes:
- The website and Eclipse help now use multi-page HTML rather than a single HTML file, although the website still contains a link to the single-page HTML that allows easily searching the full documentation (issue #36).
- Enabled section anchors for documentation on the website, and disabled section anchors for Eclipse help (issue #36).
- Several small documentation fixes and improvements (issue #166).
=== Version 0.2
Improvements and fixes:
- Documentation has been adapted to be more like the documentation of the other Eclipse ESCET tools (issue #51).
=== Version 0.1
The first release of SeText as part of the Eclipse ESCET project.
This release is based on the initial contribution by the Eindhoven University of Technology (TU/e).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment