From d36ca9cc4ea3a5be4d94a99d27b0a3b22efcd274 Mon Sep 17 00:00:00 2001 From: Jason van Zyl Date: Wed, 5 Oct 2005 17:25:27 +0000 Subject: [PATCH] o listing the sections at the top of the guide so people can jump to a particular spot if they choose. git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@295043 13f79535-47bb-0310-9956-ffa450edef68 --- .../site/apt/guides/getting-started/index.apt | 46 +++++++++++-------- 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/maven-site/src/site/apt/guides/getting-started/index.apt b/maven-site/src/site/apt/guides/getting-started/index.apt index ef62d5fc82..833e229ee2 100644 --- a/maven-site/src/site/apt/guides/getting-started/index.apt +++ b/maven-site/src/site/apt/guides/getting-started/index.apt @@ -22,10 +22,22 @@ Maven Getting Started Guide Sections - * {{{link1}What is Maven?}} + * {{{index.html#What is Maven?}What is Maven?}} + * {{{index.html#How can Maven benefit my development process?}How can Maven benefit my development process?}} + * {{{index.html#How do I make my first Maven project?}How do I make my first Maven project?}} + * {{{index.html#How do I compile my application sources?}How do I compile my application sources?}} + * {{{index.html#How do I compile my test sources and run my unit tests?}How do I compile my test sources and run my unit tests?}} + * {{{index.html#How do I create a JAR and install it in my local repository?}How do I create a JAR and install it in my local repository?}} + * {{{index.html#How do I filter resources against my POM?}How do I filter resources against my POM?}} + * {{{index.html#How do I filter resources against a properties file?}How do I filter resources against a properties file?}} + * {{{index.html#How do I use external dependencies?}How do I use external dependencies?}} + * {{{index.html#How do I deploy my jar in my remote repository?}How do I deploy my jar in my remote repository?}} + * {{{index.html#How do I create documentation?}}How do I create documentation?} + * {{{index.html#How do I deploy my site?}How do I deploy my site?}} + * {{{index.html#How do I use plug-ins?}How do I use plug-ins?}} + * {{{index.html#How do I control what version of plug-in I use?}How do I control what version of plug-in I use?}} - -* {link1} What is Maven? +* {What is Maven?} At first glance Maven can appear to be many things, but in a nutshell Maven is an attempt /my-app/target/classes Now this is simply to compile a single tree of application sources and the Ant script shown is pretty much the same size as the POM shown above. But we'll see how much more we can do with just that simple POM above! -* How do I compile my test sources and run my unit tests? +* {How do I compile my test sources and run my unit tests?} So you can now compile your applications sources and now you've got some unit tests that you want to compile and execute because every programmer always writes and executes their unit tests (nudge nudge wink wink). @@ -293,7 +305,7 @@ Results : Now that you can compile your application sources and compile your tests and execute them you'll want to move on to the next logical step so you'll be asking ... -* How do I create a JAR and install it in my local repository? +* {How do I create a JAR and install it in my local repository?} Making a JAR file is straight forward enough and can be accomplished by executing the following command: @@ -498,7 +510,7 @@ InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStr +----+ -* How do I filter resources against my POM? +* {How do I filter resources against my POM?} +----+ @@ -541,7 +553,7 @@ application.version=${pom.version} +----+ -* How do I filter resources against a properties file? +* {How do I filter resources against a properties file?} +----+ @@ -597,9 +609,7 @@ environment=${environment} +----+ -+----+ - -* How do I use external dependencies? +* {How do I use external dependencies?} You probably noticed already noticed a <<>> element in the POM we've been using as an example so you have in fact been using an external dependency but we'll here we'll go more in depth about how Maven's @@ -651,7 +661,7 @@ environment=${environment} +----+ -* How do I deploy my jar in my remote repository? +* {How do I deploy my jar in my remote repository?} +----+ @@ -725,7 +735,7 @@ environment=${environment} +----+ -* How do I create documentation? +* {How do I create documentation?} To get you jump started with Maven's documentation system you can use the archetype mechanism to generate a site for you without your existing project using the following command: @@ -811,7 +821,7 @@ m2 site:site The resulting site will be in <<>> -* How do I deploy my site? +* {How do I deploy my site?} To be able to deploy the site, you must first declare a location to distribute to in your <<>>, similar to the repository for deployment. @@ -977,9 +987,9 @@ m2 site:site site:deploy With one site descriptor by language, translated site can evolve independently. -* How do I use plug-ins? +* {How do I use plug-ins?} -* How do I control what version of plug-in I use? +* {How do I control what version of plug-in I use?} ~~http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Matrix