| <?xml version="1.0"?> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you 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 xmlns="http://maven.apache.org/XDOC/2.0" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> |
| <properties> |
| <title>Welcome to Apache Doxia Eclipse Editor Plugin</title> |
| <author email="vsiveton@apache.org">Vincent Siveton</author> |
| </properties> |
| |
| <body> |
| <section name=""> |
| <div id="logo"> |
| <img src="./images/eclipse.png" alt="Eclipse logo"/> |
| <img src="./images/doxia-logo.png" alt="Doxia logo"/> |
| </div> |
| </section> |
| |
| <section name="Apache Doxia Eclipse Editor Plugin"> |
| <p> |
| Apache Doxia Eclipse Editor Plugin is an Eclipse plugin under development. It includes several |
| new tools to support all |
| <a href="/doxia/references/index.html">Apache Doxia formats</a> in Eclipse, |
| i.e. APT, Confluence, Simplified DocBook, FML, TWiki, XDOC and Xhtml. |
| Moreover, it comes also with wizards. |
| </p> |
| <subsection name="What can Apache Doxia Eclipse Editor Plugin do for you?"> |
| <p> |
| This Eclipse Plugin: |
| </p> |
| <ul> |
| <li>Supports all Apache Doxia file formats (as of version 1.3, ie. Markdown not yet supported)</li> |
| <li>Shows the rendering of any Apache Doxia file directly, without running <code>mvn site</code></li> |
| <li>Supports color and styles highlighting in the editors</li> |
| <li>Provides helpers to insert commonly used patterns in each format (bold, italic, monospaced, link, table)</li> |
| <li>Includes wizards for creating new Apache Doxia files</li> |
| </ul> |
| <p> |
| See the <a href="usage.html">usage page</a> for screenshots and more information. |
| </p> |
| </subsection> |
| <subsection name="Brief History"> |
| <p> |
| This project was started in 2008 by Vincent Siveton (see <a href="https://issues.apache.org/jira/browse/DOXIATOOLS-8">DOXIATOOLS-8</a>) |
| but was never released. In August 2011, Hervé Boutemy wanted to revive the project. Benson Margulies was willing to help |
| by making a correct Maven build using OSGi and Tycho. Here we go now. |
| </p> |
| </subsection> |
| <subsection name="Installation"> |
| <p> |
| Use the Eclipse Update Manager to install this plugin: |
| </p> |
| <pre class="source">Go to "Help -> Install New Software... -> Work with:"</pre> |
| <p> |
| You can use the following update site: <a href="./eclipse">Doxia Editor Plugins Eclipse update site</a>. |
| </p> |
| <p> |
| You can also use the update site generated by <a href="./integration.html">ASF's Jenkins CI job</a> to get the latest updates: |
| <a href="https://builds.apache.org/view/M-R/view/Maven/job/doxia-eclipse-editor/ws/doxia-ide-eclipse/eclipse-plugins/features/org.apache.maven.doxia.ide.eclipse.feature/target/site/">Doxia Editor Plugins Eclipse (latest build) update site</a>. |
| </p> |
| </subsection> |
| </section> |
| </body> |
| </document> |