Skip to content

Commit 865768a

Browse files
slachiewiczslachiewicz
committed
Convert the site documents from APT to Markdown
65 pages, converted with doxia-converter and then cleaned up. The converter has several defects that are invisible in the Markdown and only appear in the generated HTML, so each was found by building the site before and after and diffing the normalised pages. Multiple authors were the worst: an APT header may list several, and the converter emits the first inline after 'author:' and the rest on bare continuation lines. A parser that stops at the second author loses everything after it, including the date, which then renders as body text. Ten pages were affected. Repeated YAML keys do not work either - the last wins - so multiple authors are emitted as a list. Other defects repaired: front matter emitted without its fences, headings shifted down a level, source indentation left in place so prose became code blocks, APT ordered lists emitted as '1 Item' with no period so they rendered as literal text, self-referential anchor links losing both their label and their leading '#', emphasis emitted with padding so it rendered as literal asterisks, and backslash escapes left inside code spans and in front of characters that are not markup. URLs are unchanged: an .apt and a .md of the same name both produce the same .html. 66 of 73 pages are byte-identical after normalisation, metadata included. The seven that differ are described in the pull request; none loses content. Internal link checking finds the same five pre-existing broken links as before, and no new ones.
1 parent 394808e commit 865768a

65 files changed

Lines changed: 1816 additions & 2647 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/site/markdown/guides/component-programming/index.md‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
1-
------
2-
User Guide - Component-oriented Programming
3-
------
4-
Rahul Thakur
5-
------
6-
2006-06-17
7-
------
1+
---
2+
title: User Guide - Component-oriented Programming
3+
author: Rahul Thakur
4+
date: 2006-06-17
5+
---
86

9-
What is a Component?
7+
# What is a Component?
108

11-
TODO
9+
TODO
1210

11+
# What is Component-oriented Programming (COP) all about?
1312

14-
What is Component-oriented Programming (COP) all about?
13+
TODO
1514

16-
TODO
15+
# Where does Plexus fit into picture?
1716

18-
19-
Where does Plexus fit into picture?
20-
21-
TODO
17+
TODO

‎src/site/markdown/guides/developer-guide/advanced-topics/index.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
------
2-
Developer Guide - Advanced Topics
3-
------
4-
Rahul Thakur
5-
------
6-
2006-06-17
7-
------
1+
---
2+
title: Developer Guide - Advanced Topics
3+
author: Rahul Thakur
4+
date: 2006-06-17
5+
---
86

9-
Advanced Plexus Topics
7+
# Advanced Plexus Topics

‎src/site/markdown/guides/developer-guide/advanced-topics/plexus-class-loading.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
------
2-
Developer Guide - Advanced Topics - Plexus Class Loading
3-
------
4-
Rahul Thakur
5-
------
6-
2006-06-17
7-
------
1+
---
2+
title: Developer Guide - Advanced Topics - Plexus Class Loading
3+
author: Rahul Thakur
4+
date: 2006-06-17
5+
---
86

9-
Class Loading in Plexus
7+
# Class Loading in Plexus

‎src/site/markdown/guides/developer-guide/advanced-topics/programmatic-container-configuration.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
------
2-
Developer Guide - Advanced Topics - Programmatic Container Configuration
3-
------
4-
Rahul Thakur
5-
------
6-
2006-06-17
7-
------
1+
---
2+
title: Developer Guide - Advanced Topics - Programmatic Container Configuration
3+
author: Rahul Thakur
4+
date: 2006-06-17
5+
---
86

9-
Configuring the Plexus Container Programmatically
7+
# Configuring the Plexus Container Programmatically

‎src/site/markdown/guides/developer-guide/appendices/javadoc-tags-reference.md‎

Lines changed: 34 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,48 @@
1-
------
2-
Developer Guide - Appendix I: Plexus Javadoc Tags Reference
3-
------
4-
Rahul Thakur
5-
Emmanuel Venisse
6-
------
7-
2006-07-09
8-
------
1+
---
2+
title: Developer Guide - Appendix I: Plexus Javadoc Tags Reference
3+
author:
4+
- Rahul Thakur
5+
- Emmanuel Venisse
6+
date: 2006-07-09
7+
---
98

10-
<<<The contents of this document are a work in progress>>>
9+
`The contents of this document are a work in progress`
1110

12-
Javadoc Tags used by Plexus tools
11+
# Javadoc Tags used by Plexus tools
1312

14-
Here is a reference of the Javadoc annotations that can be used to 'decorate'
15-
the Java sources to allow Plexus tools like Component Descriptor Creator (CDC)
16-
to generate Component Descriptors.
13+
Here is a reference of the Javadoc annotations that can be used to 'decorate' the Java sources to allow Plexus tools like Component Descriptor Creator (CDC) to generate Component Descriptors.
1714

18-
*-----+------+------+------+
19-
|<<Tag/Annotation>>|<<Available on>>|<<Required>>|<<Descriptor Element>>|
20-
*-----*------*------*------*
21-
| {{{#@plexus.component}@plexus.component}} | Class | Yes | Indicate to Plexus CDC that the class is a component |
22-
*-----*------*------*------*
23-
| {{{#@plexus.configuration}@plexus.configuration}} | Field | No | Tell Plexus CDC that this item should be configured through the <<<components.xml>>> |
24-
*-----*------*------*------*
25-
| {{{#@plexus.requirement}@plexus.requirement}} | Field | No | Indicate to Plexus CDC that the field is required by the component |
26-
*-----*------*------*------*
15+
|**Tag/Annotation**|**Available on**|**Required**|**Descriptor Element**|
16+
|---|---|---|---|
17+
|[@plexus.component](#@plexus.component)|Class|Yes|Indicate to Plexus CDC that the class is a component|
18+
|[@plexus.configuration](#@plexus.configuration)|Field|No|Tell Plexus CDC that this item should be configured through the `components.xml`|
19+
|[@plexus.requirement](#@plexus.requirement)|Field|No|Indicate to Plexus CDC that the field is required by the component|
2720

28-
{@plexus.component}
21+
# @plexus.component
2922

30-
The <<<@plexus.component>>> tag is used to show that the class it annotates
31-
is a plexus component. This will add a <<<<component>>>> element to the
32-
<<<<components>>>> in components.xml. The following parameters are available,
33-
but remember the <<<role>>> is required.
34-
The text in the javadoc tag describing this class is copied into the
35-
component's <<<<description>>>> tag.
23+
The `@plexus.component` tag is used to show that the class it annotates is a plexus component. This will add a `<component`\> element to the `<components`\> in components.xml. The following parameters are available, but remember the `role` is required. The text in the javadoc tag describing this class is copied into the component's `<description`\> tag.
3624

37-
*-----+------+------+
38-
|<<Parameter>>|<<Required>>|<<Description>>|
39-
*-----*------*------*
40-
| role | Yes | The role that this class provides an implementation for (usually the class name of an implemented Interface |
41-
*-----*------*------*
42-
| role-hint | No | The hints are used to differentiate multiple implementations of the same role |
43-
*-----*------*------*
44-
| version | No | Set the version of the component |
45-
*-----*------*------*
25+
|**Parameter**|**Required**|**Description**|
26+
|---|---|---|
27+
|role|Yes|The role that this class provides an implementation for (usually the class name of an implemented Interface|
28+
|role-hint|No|The hints are used to differentiate multiple implementations of the same role|
29+
|version|No|Set the version of the component|
4630

47-
{@plexus.configuration}
31+
# @plexus.configuration
4832

49-
The <<<@plexus.configuration>>> tags are used to mark fields in a class for
50-
configuration through the <<<components.xml>>>.
33+
The `@plexus.configuration` tags are used to mark fields in a class for configuration through the `components.xml`.
5134

52-
*-----+------+------+
53-
|<<Parameter>>|<<Required>>|<<Description>>|
54-
*-----*------*------*
55-
| default-value | Currently | The default values are currently required for the <<<<configuration>>>> tag to be written to <<<components.xml>>>.
56-
*-----*------*------*
35+
|**Parameter**|**Required**|**Description**|
36+
|---|---|---|
37+
|default-value|Currently|The default values are currently required for the `<configuration`> tag to be written to `components.xml`.|
5738

58-
{@plexus.requirement}
39+
# @plexus.requirement
5940

60-
Tagging a field with <<<@plexus.requirement>>> will tell plexus to inject
61-
the required component or list of components before the component itself is
62-
started. Fields can be of the type of the Interface defining the component you
63-
wish to be injected or of type <<<java.util.List>>> or <<<java.util.Map>>>.
41+
Tagging a field with `@plexus.requirement` will tell plexus to inject the required component or list of components before the component itself is started. Fields can be of the type of the Interface defining the component you wish to be injected or of type `java.util.List` or `java.util.Map`.
6442

65-
Fields of type <<<java.lang.List>>> will have a list of components injected
66-
whereas a field of type <<<java.lang.Map>>> will have a mapping in the form of
67-
<<<role-hint -> component>>>. The <<<role>>> parameter is required if using a
68-
<<<List>>> or <<<Map>>> whereas a role-hint is not allowed.
69-
70-
*-----+------+------+
71-
|<<Parameter>>|<<Required>>|<<Description>>|
72-
*-----*------*------*
73-
| role | No. Yes if the field is a <<<List>>> or a <<<Map>>> | The role parameter is used to tell plexus what Component role you are interested in. For singleton fields their type is used as a default.
74-
*-----*------*------*
75-
| role-hint | No. Not allowed if the field is a <<<List>>> or a <<<Map>>> | Links to the role-hint defined by a component when looking up a component. Not allowed with <<<List>>> or <<<Map>>> fields, as they return all <<<role-hint>>>s.
76-
*-----*------*------*
43+
Fields of type `java.lang.List` will have a list of components injected whereas a field of type `java.lang.Map` will have a mapping in the form of `role-hint -> component`. The `role` parameter is required if using a `List` or `Map` whereas a role-hint is not allowed.
7744

45+
|**Parameter**|**Required**|**Description**|
46+
|---|---|---|
47+
|role|No. Yes if the field is a `List` or a `Map`|The role parameter is used to tell plexus what Component role you are interested in. For singleton fields their type is used as a default.|
48+
|role-hint|No. Not allowed if the field is a `List` or a `Map`|Links to the role-hint defined by a component when looking up a component. Not allowed with `List` or `Map` fields, as they return all `role-hint`s.|

‎src/site/markdown/guides/developer-guide/appendices/plexus-maven-plugin-reference.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
------
2-
Developer Guide - Appendix II: Plexus Maven Plugin
3-
------
4-
Rahul Thakur
5-
------
6-
2006-07-09
7-
------
1+
---
2+
title: Developer Guide - Appendix II: Plexus Maven Plugin
3+
author: Rahul Thakur
4+
date: 2006-07-09
5+
---
86

9-
<<<The contents of this document are a work in progress>>>
7+
`The contents of this document are a work in progress`
108

11-
Plexus Maven Plugin
9+
# Plexus Maven Plugin
1210

13-
~~TODO: Discuss the use with some example of Mojos available under Plexus Maven plugin
11+
<!-- TODO: Discuss the use with some example of Mojos available under Plexus Maven plugin -->

0 commit comments

Comments
 (0)