<?xml version="1.0" encoding="UTF-8"?> | |
<!-- | |
Copyright (c) 2010 Red Hat, Inc. | |
All rights reserved. This program and the accompanying materials | |
are made available under the terms of the Eclipse Public License v1.0 | |
which accompanies this distribution, and is available at | |
http://www.eclipse.org/legal/epl-v10.html | |
Contributors: | |
Red Hat - initial API and implementation | |
Alvaro Sanchez-Leon - Adapted to Mylyn Reviews R4E | |
--> | |
<project name="org.eclipse.mylyn.reviews.r4e.help" basedir="." default="all"> | |
<description> | |
Generate Eclipse help content for the Mylyn Reviews R4E user guide | |
</description> | |
<property name="r4e.help.title" value="R4E Documentation" /> | |
<property name="r4e.ug.title" value="R4E User Guide" /> | |
<property name="help.doc.url.base" value="http://wiki.eclipse.org" /> | |
<setproxy proxyhost="!---your proxy server. If none, remove this line---!" | |
proxyport="!---your proxy server port---!"/> | |
<path id="wikitext.tasks.classpath"> | |
<fileset dir="!---your Eclipse installation plugins directory path---!"> | |
<include name="org.eclipse.mylyn.wikitext.*core*.jar" /> | |
</fileset> | |
</path> | |
<taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" /> | |
<taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" /> | |
<target name="all" description="Generate Eclipse help content for the Mylyn Reviews R4E user guide"> | |
<sequential> | |
<!-- IMPORTANT NOTE | |
This is now the preferred way to generated the R4E help plugin, using the local | |
_r4eOpen.mediawiki file located in the /doc directory. | |
After this script is executed. Do the following: | |
1) In file _r4eOpen-toc.xml, add a topic called "_Updating This Document" and make it point | |
to the _Updating-This-Document.html file located in the doc directory | |
2) In file _r4eOpen-toc.xml, add an anchor called "r4emain" under the root toc element | |
--> | |
<wikitext-to-eclipse-help markupLanguage="MediaWiki" | |
validate="true" | |
failonvalidationerror="true" | |
overwrite="true" | |
title="${r4e.help.title}" | |
multipleOutputFiles="true" | |
formatoutput="true" | |
navigationImages="true" | |
helpPrefix="doc"> | |
<fileset dir="${basedir}/doc"> | |
<include name="_r4eOpen.mediawiki" /> | |
</fileset> | |
<stylesheet url="book.css" /> | |
</wikitext-to-eclipse-help> | |
<!-- IMPORTANT NOTE2 | |
This is now used for reference only, and to verify if anything was changed on | |
the Eclipse web wiki that needs to be included to the local _r4eOpen.mediawiki file. | |
However, if you still want to generate the help plugin from the Eclipse web wiki. | |
After this script is executed. Do the following: | |
1) Change the plugin.xml configuration to point to the toc file "web/toc.xml" | |
2) In file toc.xml, add an anchor called "r4emain" under the root toc element | |
--> | |
<mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" | |
validate="true" | |
failonvalidationerror="true" | |
prependImagePrefix="images" | |
formatoutput="true" | |
dest="${basedir}/web" | |
navigationimages="true" | |
title="${r4e.help.title}" | |
helpPrefix="web" | |
generateUnifiedToc="true"> | |
<path name="Reviews/R4E/User_Guide" title="${r4e.ug.title}" /> | |
<stylesheet url="book.css" /> | |
<pageAppendum> | |
= Updating This Document = | |
This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit | |
http://wiki.eclipse.org/Reviews/R4E/User_Guide | |
</pageAppendum> | |
</mediawiki-to-eclipse-help> | |
</sequential> | |
</target> | |
</project> |