Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 2.87 KB

README.md

File metadata and controls

81 lines (59 loc) · 2.87 KB
Raw

FoxyDocs : A FOXopen documentation Editor

A simple developer tool for adding, editing and exporting documentation for one or more Fox Modules.

WARNING: The actual version is not yet ready to be used.

http://foxopen.net/

Demonstration Video

https://www.youtube.com/watch?v=J8tuOmkc5YA

Getting Started with Eclipse

This section describes how to setup the project using Eclipse.

You should be able to use an alternative IDE, such as NetBean. You however will need some libraries from Eclipse.

Install Eclipse

Download Eclipse from http://www.eclipse.org/downloads/

Install WindowBuilder

This project has been build with JFace/SWT using WindowBuilder. You'll also need a couple of libraries from this plugin.

Install it using the Eclipse Wizard Help -> Install New Software.... You'll find the URL to add here : http://www.eclipse.org/windowbuilder/download.php

Import the project

  1. Get the code from Github
  2. In Eclipse, create a new SWT/Jface Java Project (from File -> New -> Other)
  3. Set the project location to the local copy of the code

Add Databinding libraries

FoxyDocs a library called Databinding included in Eclipse. Add it to the Build Path following these steps :

  1. Open the project's Properties
  2. Go to the tab Libraries within Java Build Path
  3. Click on Add External JARs
  4. Browse to the Eclipse install directory (such ash /opt/eclipse or C:\Program Files\eclipse)
  5. Open the plugins folder
  6. Add every jars containing databinding

In the future, the relevant JARs will be added in the lib directory so we won't depend on an Eclipse installation.

Usage

  1. Open a folder containing Fox Module (Ctrl + O)
  2. Browse to each module to add proper documentation for each entry.
  • Green Tick : entry completed
  • Red Dash : partial entry
  • Red Cross : missing entry
  1. If the file is locked (grey icon), unlock it with SVN or Preforce.
  2. Save the files (Ctrl + S)
  3. Export the directory to HTML (Ctrl + H) or the currently open module to PDF (Ctrl + P)

Known issues

  • The Pretty Print function does not align with the XMLSpy one
  • Adding or removing folders or files within the opened folder may behave improperly
  • The user can select multiple text fields at the same time
  • Comments within a documentation node are not accessible
  • There is no CSS nor image in the PDF export
  • It is not possible to export an entire directory as PDF
  • After saving a file, the currently opened entry is not highlighted anymore
  • You can close an unsaved tab without any warning

Credits

Development team

  • Pierre-Dominique Putallaz
  • Mike Leonard

XSL for export

  • William Friesen

Libraries