src.site.apt.references.apt Maven / Gradle / Ivy

Go to download
 ------
 References
 ------
 Max Antoni
 ------
 24.03.2007
 ------

 ~~ Copyright (c) 2006-2007 Maximilian Antoni. All rights reserved.
 
 ~~ This software is licensed as described in the file LICENSE.txt, which you
 ~~ should have received as part of this distribution. The terms are also
 ~~ available at http://www.maxantoni.de/projects/eva-properties/license.txt.

 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/guides/mini/guide-apt-format.html

References
 
 References looks like an Ant or Maven reference. They help to reuse
 parts of your configuration. For example a reference to a system property
 can be used to create a file reference in the home directory of your
 application.
 
 A typical configuration file could look like this:
 
+----------------------------------------------+
home: ${system.user.dir}
config: "file://${home}/settings
+----------------------------------------------+
 
 Here the "home" property holds a reference to the system property "user.dir".
 The "config" property holds a file reference, that uses $\{home\} to build the
 path to the settings directory inside of the home directory.
 
 Some example references:
 
+----------------------------------------------+
reference: ${plain.reference}
string: "This text contains a ${reference}"
readme: "file://${home.dir}/readme.txt"
list-ref: ${some-list.0.foo}
+----------------------------------------------+

   * References may point to other references
   
   * You can put references in any string
   
   * Numbers are interpreted as index in lists
   
 There are some reserved references with special values. Your may set these
 values yourself:
 
   * <<$\{classloader\}>>: The java.lang.ClassLoader that was used to load this
		property file from a resource.\
		This property will be used internally to find other resources on the
		classpath if you reference a file with "classpath://my/path.eva"
		
   * <<$\{datasource-base\}>>: The base path of this property file.\
   		If this property file was loaded from the file system, it will point
   		to the parent folder.\
   		If this property file was loaded from a URL, it will point to the
   		URL without the file name portion.\
   		Use this reference to refer to other properties relatively:

+----------------------------------------------+
another-file: "file://${datasource-base}/another-file.eva
+----------------------------------------------+