From d25845da4345c884ab2ea27f06795ed3946d5496 Mon Sep 17 00:00:00 2001 From: Jason van Zyl Date: Wed, 19 Oct 2005 19:04:48 +0000 Subject: [PATCH] fix markup git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@326651 13f79535-47bb-0310-9956-ffa450edef68 --- maven-site/src/site/apt/guides/index.apt | 8 ++++- ...ction-to-the-standard-directory-layout.apt | 34 +++++++++++++++++++ .../apt/guides/mini/guide-ibiblio-upload.apt | 11 ++++++ maven-site/src/site/apt/guides/tail.txt | 6 ++++ 4 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt diff --git a/maven-site/src/site/apt/guides/index.apt b/maven-site/src/site/apt/guides/index.apt index 1377499f08..fec882dc40 100644 --- a/maven-site/src/site/apt/guides/index.apt +++ b/maven-site/src/site/apt/guides/index.apt @@ -70,7 +70,7 @@ Documentation * {{{mini/guide-using-extensions.html}Guide to using Extensions}} - * {{{mini/guide-using-modello.htmlt}Guide to using Modello}} + * {{{mini/guide-using-modello.html}Guide to using Modello}} * {{{mini/guide-webapp.html}Guide to Webapps}} @@ -123,7 +123,13 @@ Documentation * {{{../plugins/index.html}Available Plug-ins}} * {{{../developers/mojo-api-specification.html}Mojo API}} + + * {{{..//mojo-api-specification.html}Mojo API}} * {{{../ant-tasks.html}Ant Tasks}} + * {{{../glossary.html}Glossary}} + + * {{{../maven-conventions.html}Maven Conventions}} + [] diff --git a/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt b/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt index 213c4956e8..767ec5902d 100644 --- a/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt +++ b/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt @@ -8,6 +8,13 @@ Introduction to the Standard Directory Layout + Having a common directory layout would allow for users familiar with one Maven project to immediately feel + at home in another Maven project. The advantages are analogous to adopting a site-wide look-and-feel. + + The next section documents the directory layout expected by Maven and the directory layout created by + Maven. Please try to conform to this structure as much as possible; however, if you can't these settings can + be overridden via the project descriptor. + *--------------------------+-----------------------------------------------+ | src/main/java | Application/Library sources *--------------------------+-----------------------------------------------+ @@ -27,3 +34,30 @@ Introduction to the Standard Directory Layout *--------------------------+-----------------------------------------------+ | src/site | Site *--------------------------+-----------------------------------------------+ +| LICENSE.txt | Project's license +*--------------------------+-----------------------------------------------+ +| README.txt | Project's readme +*--------------------------+-----------------------------------------------+ + + At the top level files descriptive of the project: a <<>> file (and any properties, + <<>> or <<>> if using Ant). In addition, there are textual documents meant + for the user to be able to read immediately on receiving the source: <<>>, + <<>>, etc. + + There are just two subdirectories of this structure: <<>> and <<>>. The only other + directories that would be expected here are metadata like <<>> or <<<.svn>>>, and any + subprojects in a multiproject build (each of which would be laid out as above). + + The <<>>directory is used to house all output of the build. + + The <<>> directory contains all of the source material for building the project, its site and so on. + It contains a subdirectory for each type: <<
>> for the main build artifact, <<>> for + the unit test code and resources, <<>> and so on. + + Within artifact producing source directories (ie. <<
>> and <<>>), there is one + directory for the language <<>> (under which the normal package hierarchy exists), and one for + <<>> (the structure under which is copied to the target classpath given the default resource definition). + + If there are other contributing sources to the artifact build, they would be under other subdirectories: for + example <<>> would contain Antlr grammar definition files. + diff --git a/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt b/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt new file mode 100644 index 0000000000..beccca97a9 --- /dev/null +++ b/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt @@ -0,0 +1,11 @@ + ------ + Guide to uploading artifacts to Ibiblio + ------ + Jason van Zyl + ------ + 12 October 2005 + ------ + +Guide to uploading artifacts to Ibiblio + + In progress. diff --git a/maven-site/src/site/apt/guides/tail.txt b/maven-site/src/site/apt/guides/tail.txt index 3d47f0fa35..1d8565ddd7 100644 --- a/maven-site/src/site/apt/guides/tail.txt +++ b/maven-site/src/site/apt/guides/tail.txt @@ -8,7 +8,13 @@ * {{{../plugins/index.html}Available Plug-ins}} * {{{../developers/mojo-api-specification.html}Mojo API}} + + * {{{..//mojo-api-specification.html}Mojo API}} * {{{../ant-tasks.html}Ant Tasks}} + * {{{../glossary.html}Glossary}} + + * {{{../maven-conventions.html}Maven Conventions}} + []