From 4ed3a062c08e39d21b23d88f3d2a4934bac390d7 Mon Sep 17 00:00:00 2001 From: Roel Spilker Date: Mon, 2 Oct 2017 23:36:10 +0200 Subject: add ids to h1/h2/h3 for linking directly to them --- website/templates/_download-edge.html | 2 +- website/templates/_scaffold.html | 15 +++++++++++++++ website/templates/contributing.html | 6 +++--- website/templates/credits.html | 4 ++-- website/templates/features/_features.html | 16 ++++++++-------- website/templates/features/configuration.html | 4 ++-- website/templates/features/delombok.html | 8 ++++---- website/templates/features/experimental/index.html | 2 +- website/templates/features/index.html | 6 +++--- website/templates/main.html | 4 ++-- website/templates/setup/_setup.html | 4 ++-- 11 files changed, 43 insertions(+), 28 deletions(-) diff --git a/website/templates/_download-edge.html b/website/templates/_download-edge.html index 724efa58..b5e8af0b 100644 --- a/website/templates/_download-edge.html +++ b/website/templates/_download-edge.html @@ -2,7 +2,7 @@ <@main.scaffold>
-

Download 'Edgy Guinea Pig' – the Lombok Cutting Edge build

+ <@main.h1 title="Download 'Edgy Guinea Pig' - the Lombok Cutting Edge build" />
version: ${version} (${timestampString})
diff --git a/website/templates/_scaffold.html b/website/templates/_scaffold.html index cc7b0838..7de5e1d2 100644 --- a/website/templates/_scaffold.html +++ b/website/templates/_scaffold.html @@ -123,3 +123,18 @@ ga('send', 'pageview'); + +<#macro h1 title class=""> +<#assign idvalue="*"?no_esc + "${title}"/> +

${title}

+ + +<#macro h2 title class=""> +<#assign idvalue="*"?no_esc + "${title}"/> +

${title}

+ + +<#macro h3 title class=""> +<#assign idvalue="*"?no_esc + "${title}"/> +

${title}

+ diff --git a/website/templates/contributing.html b/website/templates/contributing.html index 574e3aa8..dde6e3ff 100644 --- a/website/templates/contributing.html +++ b/website/templates/contributing.html @@ -3,7 +3,7 @@ <@main.scaffold>
-

How to work on Project Lombok yourself

+ <@main.h1 title="How to work on Project Lombok yourself" />
Project Lombok is being developed via the lombok git repository on github.
@@ -13,13 +13,13 @@ To produce a lombok jar, run ant dist; in general run ant -p; there's lots of stuff there, including downloading various versions of java runtimes to run the test suite against, and building this website.

-

Adding your own handlers and annotations to Lombok

+ <@main.h2 title="Adding your own handlers and annotations to Lombok" />

If you want to extend lombok, we advise that you fork lombok and add handlers directly into the same place and package that lombok's handlers are in (lombok.javac.handlers and lombok.eclipse.handlers) – lombok does some fancy footwork to ensure various modular class loading systems don't interface with finding the lombok classes, but that system is not (currently) easily expanded to include separate jars.

-

Contributing to Project Lombok

+ <@main.h2 title="Contributing to Project Lombok" />

To create new features and add them to project lombok itself, send us pull requests via github. However, before you start, discuss the feature or fix you'd like to contribute, preferably via the Project Lombok Forum. If you're going to add a new feature, make sure to post 2 snippets (one with the annotation, the other with what that would generate), similar to how the feature pages list 'with lombok' and 'without lombok' variants. diff --git a/website/templates/credits.html b/website/templates/credits.html index 9e929256..925ba2d4 100644 --- a/website/templates/credits.html +++ b/website/templates/credits.html @@ -3,12 +3,12 @@ <@main.scaffold>

-

Project Lombok - About the authors and everyone that's helped us create Project Lombok.

+ <@main.h1 title="Project Lombok - About the authors and everyone that's helped us create Project Lombok." />
-

Regular contributors to Project Lombok:

+ <@main.h3 title="Regular contributors to Project Lombok:" />
diff --git a/website/templates/features/_features.html b/website/templates/features/_features.html index 2e338834..dcee152c 100644 --- a/website/templates/features/_features.html +++ b/website/templates/features/_features.html @@ -14,14 +14,14 @@ <#macro overview>
-

Overview

+ <@main.h3 title="Overview" /> <#nested>
<#macro experimental>
-

Experimental

+ <@main.h3 title="Experimental" /> Experimental because: <#nested> @@ -31,13 +31,13 @@ <#macro snippets name>
-

With Lombok

+ <@main.h3 title="With Lombok" />
${usages.pre(name)?no_esc}
-

Vanilla Java

+ <@main.h3 title="Vanilla Java" />
${usages.post(name)?no_esc}
@@ -46,7 +46,7 @@ <#macro confKeys>
-

Supported configuration keys:

+ <@main.h3 title="Supported configuration keys:" />
<#nested>
@@ -55,7 +55,7 @@ <#macro smallPrint>
-

Small print

+ <@main.h3 title="Small print" />
<#nested> @@ -68,9 +68,9 @@
-

${title}

+ <@main.h1 title="${title}" /> -

${logline?no_esc}

+ <@main.h3 title="${logline?no_esc}" />
<#nested> diff --git a/website/templates/features/configuration.html b/website/templates/features/configuration.html index 642332a0..0491d832 100644 --- a/website/templates/features/configuration.html +++ b/website/templates/features/configuration.html @@ -70,7 +70,7 @@ <@f.featureSection> -

Global config keys

+ <@f.main.h3 title="Global config keys" />

To stop lombok from looking at parent directories for more configuration files, the special key: @@ -98,7 +98,7 @@ <@f.featureSection> -

Config keys that can affect any source file

+ <@f.main.h3 title="Config keys that can affect any source file" />

These config keys can make lombok affect source files even if they have 0 lombok annotations in them.
diff --git a/website/templates/features/delombok.html b/website/templates/features/delombok.html index fc9dfddc..6f41fc46 100644 --- a/website/templates/features/delombok.html +++ b/website/templates/features/delombok.html @@ -13,7 +13,7 @@ Delombok's output format can be configured with command line options (use --format-help for a complete list). A few such options are automatically scanned from input if possible (such as indent). If delombok's formatting is not conforming to your preferred code style, have a look!

-

Running delombok on the command line

+ <@f.main.h3 title="Running delombok on the command line" />

Delombok is included in lombok.jar. To use it, all you need to run on the command line is: @@ -28,7 +28,7 @@

-

Running delombok in ant

+ <@f.main.h3 title="Running delombok in ant" />

lombok.jar includes an ant task which can apply delombok for you. For example, to create javadoc for your project, your build.xml file would look something like: @@ -45,13 +45,13 @@ Instead of a from attribute, you can also nest <fileset> nodes.

-

Running delombok in maven

+ <@f.main.h3 title="Running delombok in maven" />

Anthony Whitford has written a maven plugin for delomboking your source code.

-

Limitations

+ <@f.main.h3 title="Limitations" />

Delombok tries to preserve your code as much as it can, but comments may move around a little bit, especially comments that are in the middle of a syntax node. For example, any comments appearing in the middle of a list of method modifiers, such as public /*comment*/ static ... will move towards the front of the list of modifiers. In practice, any java source parsing tool will not be affected.
diff --git a/website/templates/features/experimental/index.html b/website/templates/features/experimental/index.html index 11d48485..a1ea867a 100644 --- a/website/templates/features/experimental/index.html +++ b/website/templates/features/experimental/index.html @@ -4,7 +4,7 @@ <@main.scaffold>

-

Lombok experimental features

+ <@main.h1 title="Lombok experimental features" />

diff --git a/website/templates/features/index.html b/website/templates/features/index.html index da3db634..a09c4b72 100644 --- a/website/templates/features/index.html +++ b/website/templates/features/index.html @@ -3,7 +3,7 @@ <@main.scaffold>

-

Lombok features.

+ <@main.h1 title="Lombok features." />
<@main.feature title="val" href="val"> @@ -69,7 +69,7 @@
-

Configuration system

+ <@main.h1 title="Configuration system" />
Lombok, made to order: Configure lombok features in one place for your entire project or even your workspace. @@ -77,7 +77,7 @@
-

Running delombok

+ <@main.h1 title="Running delombok" />
Delombok copies your source files to another directory, replacing all lombok annotations with their desugared form. So, it'll turn @Getter back into the actual getter. It then removes the annotation. This is useful for all sorts of reasons; you can check out what's happening under the hood, if the unthinkable happens and you want to stop using lombok, you can easily remove all traces of it in your source, and you can use delombok to preprocess your source files for source-level tools such as javadoc and GWT. More information about how to run delombok, including instructions for build tools can be found at the delombok page. diff --git a/website/templates/main.html b/website/templates/main.html index b836a3c9..374a5841 100644 --- a/website/templates/main.html +++ b/website/templates/main.html @@ -2,7 +2,7 @@ <@main.scaffold>
-

Lombok Demo

+ <@main.h1 title="Lombok Demo" />