Author: brett Date: Sun Jan 23 14:56:24 2005 New Revision: 126248 URL: http://svn.apache.org/viewcvs?view=rev&rev=126248 Log: finish tutorial, add new SCM doco skeleton Added: maven/maven-1/core/trunk/xdocs/using/scm.xml Modified: maven/maven-1/core/trunk/xdocs/navigation.xml maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml
Modified: maven/maven-1/core/trunk/xdocs/navigation.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/navigation.xml?view=diff&rev=126248&p1=maven/maven-1/core/trunk/xdocs/navigation.xml&r1=126247&p2=maven/maven-1/core/trunk/xdocs/navigation.xml&r2=126248 ============================================================================== --- maven/maven-1/core/trunk/xdocs/navigation.xml (original) +++ maven/maven-1/core/trunk/xdocs/navigation.xml Sun Jan 23 14:56:24 2005 @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <!-- /* - * Copyright 2001-2004 The Apache Software Foundation. + * Copyright 2001-2005 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -67,8 +67,9 @@ <item name="Unit Testing" href="/using/tests.html" /> <item name="Web Applications" href="/using/war.html" /> <item name="Creating a Site" href="/using/site.html" /> + <item name="Source Control" href="/using/scm.html" /> <item name="Making Releases" href="/using/releasing.html" /> - <item name="Multiple Projects" href="/using/multiproject.html" /> + <item name="Multiple Modules" href="/using/multiproject.html" /> <item name="Migrating from Ant" href="/using/migrating.html" /> <item name="Best Practices" href="/using/bestpractices.html" /> </item> Modified: maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml?view=diff&rev=126248&p1=maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml&r1=126247&p2=maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml&r2=126248 ============================================================================== --- maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml (original) +++ maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml Sun Jan 23 14:56:24 2005 @@ -209,14 +209,110 @@ </p> </subsection> -<!-- -TODO: things you'd try next: -- add to CVS, see additional reports -... + <subsection name="Customising the Build"> + <p> + In addition to the project descriptor, a number of properties can be set to customise the way + the build performs. For example, say you wanted to change some properties regarding compilation + for the project. You can create a <code>project.properties</code> file in the same location as your + <code>project.xml</code> file. + </p> + <source>maven.compile.source=1.3 +maven.compile.target=1.1 +maven.compile.debug=true</source> + <p> + There are a great number of customisation properties available, each relating to individual plugins + and some for Maven itself. For example, the above properties are defined for the + <a href="../reference/plugins/java/properties.html">Java plugin</a> which provides the + <code>java:compile</code> goal. + </p> + <p> + You can usually find a reference of the properties that will customise a plugin in each respective + plugin's documentation. A list of plugins can be found in the + <a href="../reference/plugins/plugins.html">Plugins Reference</a>, which is also linked in the navigation + of this site. + </p> + <p> + There are also a number of standard properties defined by Maven itself, which are listed in the + <a href="../reference/properties.html">properties reference</a>. + </p> + <p> + Properties are read in a particular order - while usually they will be defined in + <code>project.properties</code> to share with all users of your project, sometimes they are specific to + your environment (eg, when they include paths on your machine). In this case they should be included in + <code>build.properties</code> in either the project directory (if they are specific to the project) or + in your home directory (if they are for every project on your machine under your account). For more + information about the order properties are loaded, see the <a href="../reference/properties.html">properties + reference</a>. + </p> + </subsection> -- finish with next steps ---> + <subsection name="Generating the Site"> + <p> + As was shown previously, the project descriptor is all that is initially needed to generate a site for your + project by running: + </p> + <source>maven site</source> + <p> + The next step in this process is to add some custom documentation to the site. This might be some basic + usage instructions, linking out the Javadoc and other references, or it might be a complete project site + depending on your preference. + </p> + <p> + To try this, add a file called <code>xdocs/index.xml</code> in your project with the following content: + </p> + <source><![CDATA[<document> + <properties> + <title>Hello World</title> + <author email="[EMAIL PROTECTED]">Me</author> + </properties> + + <body> + <section name="Section 1"> + <p> + Hello world! + </p> + </section> + </body> +</document>]]></source> + <p> + To view your new index page in <code>target/docs/index.html</code>, regenerate the site again: + </p> + <source>maven site</source> + <p> + Any XHTML will be accepted within the <section /> tags, as well as other special tags. Some HTML, + such as tables, are also styled specially. For more information on building a site, see the + <a href="../using/site.html">User's Guide</a>. + </p> + </subsection> + </section> + + <section name="Where to next?"> + <p> + Thanks for giving Maven the ten minute test! If you have any feedback (positive and negative), please + email the <a href="../mail-lists.html">Maven Users List</a>. + </p> + <p> + This tutorial has hopefully given enough information on how easy it is to start a new project with + Maven. Luckily, creating more complex projects is just as easy as Maven encourages you to build up + projects consistently, like building blocks. + </p> + <p> + It is recommended that you read the areas of the <a href="../using/index.html">User's Guide</a> + that relate to the particular type of project you are working on next. This includes: + </p> + <ul> + <li>Utilising source control</li> + <li>Working with multi-module projects</li> + <li>Releasing a project and deploying it to a repository</li> + </ul> + <p> + As previously mentioned, you can also find more help on using a particular plugin in each plugin's + documentation mini-site, which are listed in the <a href="../reference/plugins/plugins.html">Plugins + Reference</a>. There is also a <a href="../reference/index.html">Reference area</a> for more general + Maven documentation. + </p> </section> </body> </document> + Added: maven/maven-1/core/trunk/xdocs/using/scm.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/using/scm.xml?view=auto&rev=126248 ============================================================================== --- (empty file) +++ maven/maven-1/core/trunk/xdocs/using/scm.xml Sun Jan 23 14:56:24 2005 @@ -0,0 +1,33 @@ +<?xml version="1.0"?> +<!-- +/* + * Copyright 2001-2004 The Apache Software Foundation. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + --> + +<document> + + <properties> + <title>Working with Source Control</title> + <author email="[EMAIL PROTECTED]">Brett Porter</author> + </properties> + + <body> + <section name="Working with Source Control"> + <!-- TODO --> + <p>...</p> + </section> + </body> +</document> --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
