Skip to content

Commit

Permalink
Added quick fixes, refactor rename, show references documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ylussaud committed Jan 29, 2024
1 parent a02f7ca commit ab2d4c8
Show file tree
Hide file tree
Showing 17 changed files with 167 additions and 116 deletions.
5 changes: 1 addition & 4 deletions plugins/org.eclipse.acceleo.aql.doc/doc/AQL/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -466,11 +466,8 @@
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-08-24 10:27:31 +0200
Last updated 2023-05-09 16:19:19 +0200
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/highlight.min.js"></script>
<script>hljs.initHighlighting()</script>
</body>
</html>
9 changes: 3 additions & 6 deletions plugins/org.eclipse.acceleo.aql.doc/doc/Acceleo/generate.html
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ <h3 id="_eclipse">Eclipse</h3>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/RunAs.png" alt="Run As">
<img src="images/RunAs.png" alt="Run As">
</div>
</div>
<div class="paragraph">
Expand All @@ -497,7 +497,7 @@ <h3 id="_eclipse">Eclipse</h3>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/LaunchConfig.png" alt="Launch Configuration">
<img src="images/LaunchConfig.png" alt="Launch Configuration">
</div>
</div>
<div class="admonitionblock important">
Expand Down Expand Up @@ -602,11 +602,8 @@ <h3 id="_maventycho">Maven/Tycho</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-02-21 11:09:03 +0100
Last updated 2023-05-09 16:19:19 +0200
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/highlight.min.js"></script>
<script>hljs.initHighlighting()</script>
</body>
</html>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion plugins/org.eclipse.acceleo.aql.doc/doc/Acceleo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ <h2 id="_migrate_acceleo_3_templates_to_acceleo_4">8. Migrate Acceleo 3 template
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-08-24 10:27:31 +0200
Last updated 2023-05-09 16:19:19 +0200
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
Expand Down
7 changes: 2 additions & 5 deletions plugins/org.eclipse.acceleo.aql.doc/doc/Acceleo/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -447,19 +447,16 @@
<p>When installing the update site you must ensure that <strong>"Contact all update sites during install to find required software"</strong> is checked and that in the <strong>"Manage&#8230;&#8203;"</strong> dialog, the <strong>"Latest Eclipse Release"</strong> update site is checked.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/InstallDependencies.png" alt="Install Acceleo"></span></p>
<p><span class="image"><img src="images/InstallDependencies.png" alt="Install Acceleo"></span></p>
</div>
<div class="paragraph">
<p>For those of you who need to retrieve the source code of Acceleo, it is available on Git: <a href="https://git.eclipse.org/c/acceleo/org.eclipse.acceleo.git/" class="bare">https://git.eclipse.org/c/acceleo/org.eclipse.acceleo.git/</a>.</p>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-08-24 10:27:31 +0200
Last updated 2023-05-09 16:19:19 +0200
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/highlight.min.js"></script>
<script>hljs.initHighlighting()</script>
</body>
</html>
50 changes: 46 additions & 4 deletions plugins/org.eclipse.acceleo.aql.doc/doc/Acceleo/language.html
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,7 @@
<li><a href="#_intended_audience">Intended Audience</a></li>
<li><a href="#_module">Module</a></li>
<li><a href="#_template">Template</a></li>
<li><a href="#_white_spaces">White spaces</a></li>
<li><a href="#_query">Query</a></li>
</ul>
</div>
Expand Down Expand Up @@ -847,6 +848,50 @@ <h4 id="_variable">Variable</h4>
</div>
</div>
<div class="sect2">
<h3 id="_white_spaces">White spaces</h3>
<div class="paragraph">
<p>When generating text, and especially code, white spaces and indentation is an important point.
In order to keep template code indentation from interfering with the generated output, a few rules applies:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>each block has a <strong>mandatory indentation</strong> of <strong>two characters</strong> that will not be generated in the output (in yellow below)</p>
</li>
<li>
<p>when generating a block if the last generated line is not empty, it is repeated at the beginning of each line generated by the block (in red below)</p>
</li>
</ul>
</div>
<div class="imageblock">
<div class="content">
<img src="images/Indentation.png" alt="Indentation">
</div>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">
<div class="paragraph">
<p>In a template you have to <strong>let 2 whitespaces at the beginning of each line</strong>, else the generated content will be truncated by 2 characters.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="imageblock">
<div class="content">
<img src="images/IndentationIssue.png" alt="Truncated generation due to indentation">
</div>
</div>
<div class="paragraph">
<p>Their is one exception to this rule, an empty line in the module will generate an empty line in the output. This allows to either generate an empty line that use indentation or an empty line regardless of current indentation:</p>
</div>
</div>
<div class="sect2">
<h3 id="_query">Query</h3>
<div class="paragraph">
<p>A query is a re-useable AQL expression that can return any type of Object. They are commonly used to extract information from the input models. A query is enclosed in a <code>[query &#8230;&#8203;]</code> tag.</p>
Expand Down Expand Up @@ -919,11 +964,8 @@ <h3 id="_query">Query</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-05-09 14:44:40 +0200
Last updated 2024-01-29 17:40:43 +0100
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/highlight.min.js"></script>
<script>hljs.initHighlighting()</script>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -1027,11 +1027,8 @@ <h4 id="_comments">Comments</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-08-24 10:27:31 +0200
Last updated 2023-05-09 16:19:19 +0200
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/highlight.min.js"></script>
<script>hljs.initHighlighting()</script>
</body>
</html>
17 changes: 7 additions & 10 deletions plugins/org.eclipse.acceleo.aql.doc/doc/Acceleo/start.html
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@
</div>
<div class="imageblock">
<div class="content">
<img src="./images/NewProjectWizard.png" alt="NewProjectWizard">
<img src="images/NewProjectWizard.png" alt="NewProjectWizard">
</div>
</div>
<div class="paragraph">
Expand All @@ -479,7 +479,7 @@
</div>
<div class="imageblock">
<div class="content">
<img src="./images/NewProject.png" alt="NewProject">
<img src="images/NewProject.png" alt="NewProject">
</div>
</div>
<div class="olist arabic">
Expand All @@ -503,23 +503,23 @@
</div>
<div class="imageblock">
<div class="content">
<img src="./images/NewFile.png" alt="NewFile">
<img src="images/NewFile.png" alt="NewFile">
</div>
</div>
<div class="paragraph">
<p>An empty editor opens, you can start writing your generation template.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/NewTemplate.png" alt="NewTemplate">
<img src="images/NewTemplate.png" alt="NewTemplate">
</div>
</div>
<div class="paragraph">
<p>In order to launch an Acceleo generator, you just have to right-click on your main module and use the <strong>Run As</strong> menu.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/RunAs.png" alt="Run As">
<img src="images/RunAs.png" alt="Run As">
</div>
</div>
<div class="paragraph">
Expand All @@ -543,7 +543,7 @@
</div>
<div class="imageblock">
<div class="content">
<img src="./images/LaunchConfig.png" alt="Launch Configuration">
<img src="images/LaunchConfig.png" alt="Launch Configuration">
</div>
</div>
<div class="admonitionblock important">
Expand All @@ -565,11 +565,8 @@
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-02-21 11:31:39 +0100
Last updated 2023-05-09 16:19:19 +0200
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/highlight.min.js"></script>
<script>hljs.initHighlighting()</script>
</body>
</html>
Loading

0 comments on commit ab2d4c8

Please sign in to comment.