directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From seelm...@apache.org
Subject svn commit: r511327 - in /directory/ldapstudio/trunk/ldapstudio-rcp-help: build.xml ivy.xml src/main/resources/0_index.xml
Date Sat, 24 Feb 2007 19:23:34 GMT
Author: seelmann
Date: Sat Feb 24 11:23:33 2007
New Revision: 511327

URL: http://svn.apache.org/viewvc?view=rev&rev=511327
Log:
Added an ant task to generate a PDF version of the user's guide.
Optimized images and tables for PDF output

Modified:
    directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml
    directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml
    directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml

Modified: directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml?view=diff&rev=511327&r1=511326&r2=511327
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml (original)
+++ directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml Sat Feb 24 11:23:33 2007
@@ -23,6 +23,7 @@
 	<property name="project.output" value="${basedir}/target" />
 	<property name="project.build" value="${project.output}/build" />
 	<property name="project.html" value="${project.output}/html" />
+	<property name="project.pdf" value="${project.output}/pdf" />
 	<property name="project.src" value="${basedir}/src/main/resources" />
 
 	<property name="lib.dir" value="lib" />
@@ -64,7 +65,6 @@
 				<include name="docbook-xsl-*"/>
 			</fileset>
 		</delete>
-
 
 	</target>
 
@@ -78,6 +78,8 @@
 
 			<classpath location="lib/xalan-2.7.0.jar" />
 
+			<param name="ignore.image.scaling" expression="1" />			
+			
 			<param name="manifest.in.base.dir" expression="0" />
 			<param name="base.dir" expression="html/" />
 
@@ -156,6 +158,8 @@
 		<xslt in="${project.src}/0_index.xml" out="${project.html}/index.html" style="${basedir}/docbook-xsl/html/chunk.xsl">
 
 			<classpath location="lib/xalan-2.7.0.jar" />
+			
+			<param name="ignore.image.scaling" expression="1" />
 
 			<param name="manifest.in.base.dir" expression="0" />
 			<!-- <param name="base.dir" expression="html/" /> -->
@@ -188,13 +192,68 @@
 			<outputproperty name="indent" value="es" />
 		</xslt>
 
-
 		<tstamp>
 			<format pattern="yyyy-MMM-dd, HH:mm 'GMT'Z" property="timestamp" locale="en" />
 		</tstamp>
 		<echo message="${project.name}-${project.version} compiled ${timestamp} by ${user.name}"
file="${project.html}/compile.timestamp" />
 	</target>
 
+	<!-- ================================== -->
+	<!--           STATIC PDF               -->
+	<!-- ================================== -->
+	<target name="static-pdf" depends="resolve" description="Generates the static pdf">
+				
+		<property name="fop.dir" value="${basedir}/lib"/>
+		<taskdef name="fop"
+		         classname="org.apache.fop.tools.anttasks.Fop">
+		         <classpath>
+		            <pathelement location="${fop.dir}/avalon-framework-api-4.2.0.jar"/>
+		            <pathelement location="${fop.dir}/avalon-framework-impl-4.2.0.jar"/>
+		            <pathelement location="${fop.dir}/commons-logging-1.1.jar"/>
+		            <pathelement location="${fop.dir}/commons-io-1.3.1.jar"/>
+		            <pathelement location="${fop.dir}/fop-0.9.3.jar"/>
+		            <pathelement location="${fop.dir}/batik-all-1.6.jar"/>
+		            <pathelement location="${fop.dir}/xmlgraphics-commons-1.1.jar"/>
+		         </classpath>
+		</taskdef>
+		
+		<mkdir dir="${project.pdf}" />
+		<copy todir="${project.pdf}">
+			<fileset dir="${basedir}/resources">
+				<include name="**" />
+			</fileset>
+		</copy>
+
+		<xslt in="${project.src}/0_index.xml" out="${project.pdf}/Apache_Directory_LDAP_Studio.fo"
style="${basedir}/docbook-xsl/fo/docbook.xsl">
+
+			<classpath location="lib/xalan-2.7.0.jar" />
+			
+			<param name="manifest.in.base.dir" expression="0" />
+
+			<param name="generate.section.toc.level" expression="5" />
+			<param name="toc.max.depth" expression="3" />
+
+			<param name="ulink.target" expression="_self" />
+			<param name="suppress.navigation" expression="0" />
+			<param name="use.id.as.filename" expression="1" />
+			<param name="chapter.autolabel" expression="I" />
+			<param name="section.autolabel" expression="1" />
+			
+			<outputproperty name="method" value="xml" />
+			<outputproperty name="standalone" value="yes" />
+			<outputproperty name="encoding" value="iso8859_1" />
+			<outputproperty name="indent" value="es" />
+		</xslt>
+
+		<fop format="application/pdf" basedir="${project.pdf}"
+	        fofile="${project.pdf}/Apache_Directory_LDAP_Studio.fo"
+	        outfile="${project.pdf}/Apache_Directory_LDAP_Studio.pdf" />
+
+		<tstamp>
+			<format pattern="yyyy-MMM-dd, HH:mm 'GMT'Z" property="timestamp" locale="en" />
+		</tstamp>
+		<echo message="${project.name}-${project.version} compiled ${timestamp} by ${user.name}"
file="${project.pdf}/compile.timestamp" />
+	</target>
 
 	<!-- ================================== -->
 	<!--              JAR                   -->

Modified: directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml?view=diff&rev=511327&r1=511326&r2=511327
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml (original)
+++ directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml Sat Feb 24 11:23:33 2007
@@ -22,5 +22,12 @@
 		<dependency org="org.apache.xalan" name="xalan" rev="2.7.0"/>
 		<dependency org="docbook" name="docbook-xml" rev="4.5"/>
 		<dependency org="docbook" name="docbook-xsl" rev="1.71.1"/>
+		<dependency org="commons-logging" name="commons-logging" rev="1.1"/>
+		<dependency org="commons-io" name="commons-io" rev="1.3.1"/>
+		<dependency org="avalon-framework" name="avalon-framework-api" rev="4.2.0"/>
+		<dependency org="avalon-framework" name="avalon-framework-impl" rev="4.2.0"/>
+		<dependency org="org.apache.xmlgraphics" name="fop" rev="0.9.3"/>
+		<dependency org="org.apache.xmlgraphics" name="commons" rev="1.1"/>
+		<dependency org="org.apache.xmlgraphics" name="batik" rev="1.6"/>
     </dependencies>
 </ivy-module>

Modified: directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml?view=diff&rev=511327&r1=511326&r2=511327
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml (original)
+++ directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml Sat Feb
24 11:23:33 2007
@@ -17,10 +17,10 @@
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
--->
-<book>
+-->
+<book>
 	<bookinfo>
-		<title>LDAP Studio User's Guide</title>
+		<title>LDAP Studio User's Guide</title>
 		<copyright>
 			<year>2007</year>
 			<holder>Apache Software Foundation</holder>
@@ -45,7 +45,7 @@
 			<ulink url="http://people.apache.org/~pamarcelot/ldapstudio/downloads/">http://people.apache.org/~pamarcelot/ldapstudio/downloads/</ulink>.</para>
 			<para><emphasis role="strong">System requirements</emphasis></para>
 			<para>
-				<itemizedlist>
+				<itemizedlist>
 					<listitem>Mac OS X 10.4 or later, Windows, Linux or Solaris</listitem>
 					<listitem><ulink url="http://www.java.com/">Java Runtime Environment</ulink>
5 or later</listitem>
 				</itemizedlist>
@@ -100,7 +100,7 @@
 		<section id="updating">
 			<title>Updating LDAP Studio</title>
 			<para>To check to see whether there are updates for features of LDAP Studio (requires
Internet access):</para>
-			<para>1. Click  <emphasis role="strong">Help > Software Updates > <imageobject><imagedata
fileref="images/search-updates.png" format="PNG" /></imageobject> Search for updates...</emphasis>.

+			<para>1. Click  <emphasis role="strong">Help > Software Updates > <imageobject><imagedata
contentdepth="1em" fileref="images/search-updates.png" format="PNG" /></imageobject>
Search for updates...</emphasis>. 
 				This will contact LDAP Studio Web site to discover what versions of those features are
available. The potential 
 				upgrades are presented in on the next page.</para>
 			<para>2. Select the feature versions that you wish to upgrade, and click <emphasis
role="strong">Next</emphasis>.</para>
@@ -118,9 +118,9 @@
 			<!-- INSPECTING THE CURRENT CONFIGURATION SECTION -->
 			<section id="inspecting_configuration">
 				<title>Inspecting the current configuration</title>
-				<para>The <emphasis role="strong">Help > <imageobject><imagedata
fileref="images/about.png" format="PNG" /></imageobject> About LDAP Studio</emphasis>
dialog shows most of the important information about the features and plug-in configured
+				<para>The <emphasis role="strong">Help > <imageobject><imagedata
contentdepth="1em" fileref="images/about.png" format="PNG" /></imageobject> About
LDAP Studio</emphasis> dialog shows most of the important information about the features
and plug-in configured
 					 in the product. To find out further detailed information about the current configuration:</para>
-				<para>1. Open the update configuration manager by clicking <emphasis role="strong">
Help > Software Updates > <imageobject><imagedata fileref="images/manage-configuration.png"
format="PNG" /></imageobject> Manage Configuration</emphasis>. 
+				<para>1. Open the update configuration manager by clicking <emphasis role="strong">
Help > Software Updates > <imageobject><imagedata contentdepth="1em" fileref="images/manage-configuration.png"
format="PNG" /></imageobject> Manage Configuration</emphasis>. 
 					This opens the Product Configuration dialog.</para>
 				<para>2. In the Product Configuration dialog expand the root node (current  configuration).
The first tier of items are locations on 
 					the local computer where the files for features and plug-ins are stored. For a typical
product, all features are installed in a single 
@@ -144,7 +144,7 @@
 			<section id="enabling_disabling_uninstalling_features">
 				<title>Enabling, disabling and uninstalling features</title>
 				<para>You can browse and manage your configuration from the <emphasis role="strong">Product
Configuration dialog</emphasis>. Open the <emphasis role="strong">Product Configuration</emphasis>
dialog by 
-					clicking <emphasis role="strong"> Help > Software Updates > <imageobject><imagedata
fileref="images/manage-configuration.png" format="PNG" /></imageobject> Manage Configuration</emphasis>.</para>
+					clicking <emphasis role="strong"> Help > Software Updates > <imageobject><imagedata
contentdepth="1em" fileref="images/manage-configuration.png" format="PNG" /></imageobject>
Manage Configuration</emphasis>.</para>
 				<para>1. <emphasis role="strong">Disabling a feature</emphasis>: select
the feature and click <emphasis role="strong">Disable</emphasis> in the right
pane of the dialog. This option is available only when the 
 					feature is currently enabled, and the feature is either an optional feature or a root
feature (not included by other features).</para>
 				<para>2. <emphasis role="strong">Enabling a feature</emphasis>: First,
ensure <emphasis role="strong">Show Disabled Features</emphasis>  is turned on
in the tool bar. Then, select a disabled optional or root 
@@ -159,10 +159,10 @@
 		<!-- REPORTING A BUG SECTION -->
 		<section id="reporting_a_bug">
 			<title>Reporting a bug</title>
-			<para>Use the <emphasis role="strong">Help > <imageobject><imagedata
fileref="images/bug-report.png" format="PNG" /></imageobject> Report a bug...</emphasis>
menu item to report any bug you find on LDAP Studio.</para>
+			<para>Use the <emphasis role="strong">Help > <imageobject><imagedata
contentdepth="1em" fileref="images/bug-report.png" format="PNG" /></imageobject>
Report a bug...</emphasis> menu item to report any bug you find on LDAP Studio.</para>
 			<para>You will be redirected on your default Web browser to our issue tracking software
called Jira.</para>
 			<para>You can also reach it using this address : <ulink url="https://issues.apache.org/jira/browse/DIRSTUDIO">https://issues.apache.org/jira/browse/DIRSTUDIO</ulink></para>
-			<para><imageobject><imagedata fileref="images/jira-screenshot.png" format="PNG"
/></imageobject></para>
+			<para><imageobject><imagedata scale="50" fileref="images/jira-screenshot.png"
format="PNG" /></imageobject></para>
 			<para>To report a bug:</para>
 			<para>1. Click the <emphasis role="strong">Create a new issue</emphasis>
link in the menu.</para>
 			<para>2. Make sure the selected project is 'Directory LDAP Studio' and the issue
type is 'Bug'. Click <emphasis role="strong">Next</emphasis>.</para>
@@ -180,7 +180,7 @@
 		<section id="preferences">
 			<title>Preferences</title>
 			<para>The <emphasis role="strong">Preferences</emphasis> dialog is the
dialog used to set user preferences. The Preferences dialog pages can be searched using the
filter function. To filter by matching the page title, simply type the name of the page you
are seeking and the available pages will be presented below. The filter also searches on keywords
such as appearance and java. The history controls allow you to navigate through previously
viewed pages. To step back or forward several pages at a time, click the drop down arrow and
a list of the most recently viewed preference pages will appear.</para>
-			<para>The Preferences dialog can be found from the main workbench <emphasis role="strong">Window</emphasis>
menu under <emphasis role="strong">Window > <imageobject><imagedata fileref="images/preferences.png"
format="PNG" /></imageobject> Preferences</emphasis>. Preference pages contributed
by plug-ins will be found in this dialog.</para>
+			<para>The Preferences dialog can be found from the main workbench <emphasis role="strong">Window</emphasis>
menu under <emphasis role="strong">Window > <imageobject><imagedata contentdepth="1em"
fileref="images/preferences.png" format="PNG" /></imageobject> Preferences</emphasis>.
Preference pages contributed by plug-ins will be found in this dialog.</para>
 			
 			<!-- HELP SECTION -->
 			<section id="help">
@@ -188,7 +188,10 @@
 				<para>On the <emphasis role="strong">Help</emphasis> preferences page,
you can indicate how to display help information.</para>
 				<para>
 					<informaltable>
-						<tgroup cols="3">
+						<tgroup cols="3">
+							<colspec colname="Option" colwidth="1* "/>
+							<colspec colname="Description" colwidth="2*" />
+							<colspec colname="Default" colwidth="1*" />
 							<thead>
 								<row>
 									<entry>Option</entry>
@@ -231,7 +234,7 @@
 					<screenshot>
 						<mediaobject>
 							<imageobject>
-								<imagedata
+								<imagedata scale="50"
 									fileref="images/help_screen.png" format="PNG" />
 							</imageobject>
 						</mediaobject>
@@ -245,8 +248,11 @@
 					<para>Help system includes an internal server that serves help contents to the
browser. Use the <emphasis role="strong">Help > Help Server</emphasis> preference
page to change the interface and port that the servers uses. You should only change these
settings if you experience problems and cannot view help with the default preferences.</para>
 					<para>
 						<informaltable>
-							<tgroup cols="3">
-								<thead>
+							<tgroup cols="3">
+								<colspec colname="Option" colwidth="1* "/>
+								<colspec colname="Description" colwidth="2*" />
+								<colspec colname="Default" colwidth="1*" />
+								<thead>
 									<row>
 										<entry>Option</entry>
 										<entry>Description</entry>
@@ -273,7 +279,7 @@
 						<screenshot>
 							<mediaobject>
 								<imageobject>
-									<imagedata
+									<imagedata scale="50"
 										fileref="images/help-server_screen.png" format="PNG" />
 								</imageobject>
 							</mediaobject>
@@ -288,7 +294,10 @@
 				<para>The following preferences can be changed on the Install/Update page:</para>
 				<para>
 						<informaltable>
-							<tgroup cols="3">
+							<tgroup cols="3">
+								<colspec colname="Option" colwidth="1* "/>
+								<colspec colname="Description" colwidth="2*" />
+								<colspec colname="Default" colwidth="1*" />
 								<thead>
 									<row>
 										<entry>Option</entry>
@@ -337,7 +346,7 @@
 						<screenshot>
 							<mediaobject>
 								<imageobject>
-									<imagedata
+									<imagedata scale="50"
 										fileref="images/install-update_screen.png" format="PNG" />
 								</imageobject>
 							</mediaobject>
@@ -351,7 +360,10 @@
 				<para>The following preferences can be changed on the <emphasis role="strong">Text
Editors</emphasis> page.</para>
 				<para>
 					<informaltable>
-						<tgroup cols="3">
+						<tgroup cols="3">
+							<colspec colname="Option" colwidth="1* "/>
+							<colspec colname="Description" colwidth="2*" />
+							<colspec colname="Default" colwidth="1*" />
 							<thead>
 								<row>
 									<entry>Option</entry>
@@ -419,7 +431,7 @@
 					<screenshot>
 						<mediaobject>
 							<imageobject>
-								<imagedata
+								<imagedata scale="50"
 									fileref="images/text-editors_screen.png" format="PNG" />
 							</imageobject>
 						</mediaobject>
@@ -432,7 +444,10 @@
 					<para>The following preferences can be changed on the <emphasis role="strong">Text
Editors > Accessibility</emphasis> page.</para>
 					<para>
 						<informaltable>
-							<tgroup cols="3">
+							<tgroup cols="3">
+								<colspec colname="Option" colwidth="1* "/>
+								<colspec colname="Description" colwidth="2*" />
+								<colspec colname="Default" colwidth="1*" />
 								<thead>
 									<row>
 										<entry>Option</entry>
@@ -465,7 +480,7 @@
 						<screenshot>
 							<mediaobject>
 								<imageobject>
-									<imagedata
+									<imagedata scale="50"
 										fileref="images/accessibility_screen.png" format="PNG" />
 								</imageobject>
 							</mediaobject>
@@ -479,7 +494,10 @@
 					<para>The following preferences can be changed on the <emphasis role="strong">Text
Editors > Annotations</emphasis> preference page.</para>
 					<para>
 						<informaltable>
-							<tgroup cols="2">
+							<tgroup cols="2">
+								<colspec colname="Option" colwidth="1* "/>
+								<colspec colname="Description" colwidth="2*" />
+								<colspec colname="Default" colwidth="1*" />
 								<thead>
 									<row>
 										<entry>Option</entry>
@@ -512,7 +530,7 @@
 						<screenshot>
 							<mediaobject>
 								<imageobject>
-									<imagedata
+									<imagedata scale="50"
 										fileref="images/annotations_screen.png" format="PNG" />
 								</imageobject>
 							</mediaobject>
@@ -528,7 +546,7 @@
 						<screenshot>
 							<mediaobject>
 								<imageobject>
-									<imagedata
+									<imagedata scale="50"
 										fileref="images/linked-mode_screen.png" format="PNG" />
 								</imageobject>
 							</mediaobject>
@@ -542,7 +560,10 @@
 					<para>The following preferences can be changed on the <emphasis role="strong">Text
Editors > Quick Diff</emphasis> preference page.</para>
 					<para>
 						<informaltable>
-							<tgroup cols="3">
+							<tgroup cols="3">
+								<colspec colname="Option" colwidth="1* "/>
+								<colspec colname="Description" colwidth="2*" />
+								<colspec colname="Default" colwidth="1*" />
 								<thead>
 									<row>
 										<entry>Option</entry>
@@ -596,7 +617,7 @@
 						<screenshot>
 							<mediaobject>
 								<imageobject>
-									<imagedata
+									<imagedata scale="50"
 										fileref="images/quick-diff_screen.png" format="PNG" />
 								</imageobject>
 							</mediaobject>
@@ -610,7 +631,10 @@
 					<para>The following preferences can be changed on the <emphasis role="strong">Text
Editors > Spelling</emphasis> preference page.</para>
 					<para>
 						<informaltable>
-							<tgroup cols="3">
+							<tgroup cols="3">
+								<colspec colname="Option" colwidth="1* "/>
+								<colspec colname="Description" colwidth="2*" />
+								<colspec colname="Default" colwidth="1*" />
 								<thead>
 									<row>
 										<entry>Option</entry>
@@ -678,7 +702,7 @@
 						<screenshot>
 							<mediaobject>
 								<imageobject>
-									<imagedata
+									<imagedata width="15cm"
 										fileref="images/spelling_screen.png" format="PNG" />
 								</imageobject>
 							</mediaobject>



Mime
View raw message