Attachment #213135 for bug #375229

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

View | Details | Raw Unified | Return to bug 375229
Collapse All | Expand All

Lines 5-12 Link Here

(-)a/org.eclipse.mylyn.docs.epub.ant.core/META-INF/MANIFEST.MF (-2 / +1 lines)
5	Bundle-Version: 0.8.0.qualifier	5	Bundle-Version: 0.8.0.qualifier
6	Bundle-Vendor: Torkild U. Resheim	6	Bundle-Vendor: Torkild U. Resheim
7	Bundle-RequiredExecutionEnvironment: J2SE-1.5	7	Bundle-RequiredExecutionEnvironment: J2SE-1.5
8	Export-Package: org.eclipse.mylyn.docs.epub.ant;x-internal:=true,	8	Export-Package: org.eclipse.mylyn.docs.epub.ant.core;x-internal:=true;uses:="org.eclipse.mylyn.docs.epub,org.apache.tools.ant.types,org.apache.tools.ant"
9	org.eclipse.mylyn.docs.epub.ant.core;x-internal:=true;uses:="org.eclipse.mylyn.docs.epub,org.apache.tools.ant.types,org.apache.tools.ant"
10	Require-Bundle: org.apache.ant;bundle-version="1.8.2",	9	Require-Bundle: org.apache.ant;bundle-version="1.8.2",
11	org.eclipse.ant.core;bundle-version="3.2.300",	10	org.eclipse.ant.core;bundle-version="3.2.300",
12	org.eclipse.mylyn.docs.epub.core;bundle-version="0.8.0"	11	org.eclipse.mylyn.docs.epub.core;bundle-version="0.8.0"




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * 
 * @author Torkild U. Resheim
 * @ant.type name="contributor" category="epub"
 */
public class ContributorType {

	String fileAs;

	String id;

	Locale lang;

	String name;

	String role;

	/**
	 * @ant.not-required
	 */
	public void setFileAs(String fileAs) {
		this.fileAs = fileAs;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.not-required the language code
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}

	/**
	 * @ant.required name of the contributor
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * @ant.not-required
	 */
	public void setRole(String role) {
		this.role = role;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

/**
 * 
 * @author Torkild U. Resheim
 * @ant.type name="cover" category="epub"
 */
public class CoverType {

	String image;

	String value;

	/**
	 * @ant.required
	 */
	public void addText(String value) {
		this.value = value;
	}

	/**
	 * @ant.required
	 */
	public void setImage(String image) {
		this.image = image;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * 
 * @author Torkild U. Resheim
 * @ant.type name="coverage" category="epub"
 */
public class CoverageType {

	String id;

	String text;

	Locale lang;

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.not-required
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * 
 * @author Torkild U. Resheim
 * @ant.type name="creator" category="epub"
 */
public class CreatorType {

	String fileAs;

	String id;

	Locale lang;

	String name;

	String role;

	/**
	 * @ant.not-required
	 */
	public void setFileAs(String fileAs) {
		this.fileAs = fileAs;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.not-required
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}

	/**
	 * @ant.required
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * @ant.not-required
	 */
	public void setRole(String role) {
		this.role = role;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

/**
 * 
 * @author Torkild U. Resheim
 * @ant.type name="date" category="epub"
 */
public class DateType {

	String date;

	String event;

	String id;

	/**
	 * @ant.required
	 */
	public void setDate(String date) {
		this.date = date;
	}

	/**
	 * @ant.not-required
	 */
	public void setEvent(String event) {
		this.event = event;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.io.File;
import java.util.ArrayList;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.eclipse.mylyn.docs.epub.core.EPUB;
import org.eclipse.mylyn.docs.epub.core.OPSPublication;
import org.eclipse.mylyn.docs.epub.opf.Role;
import org.eclipse.mylyn.docs.epub.opf.Type;

/**
 * Assemble a new EPUB.
 * 
 * 
 * @author Torkild U. Resheim
 * @ant.task name="epub" category="epub"
 */
public class EpubTask extends Task {

	private final OPSPublication ops = OPSPublication.getVersion2Instance();

	private final ArrayList<FileSetType> filesets;

	private TocType toc = null;

	private File workingFolder;

	private File epubFile;

	public EpubTask() {
		super();
		filesets = new ArrayList<FileSetType>();
	}

	public void addConfiguredContributor(ContributorType item) {
		if (item.role == null) {
			ops.addContributor(item.id, item.lang, item.name, null, item.fileAs);
		} else {
			ops.addContributor(item.id, item.lang, item.name, Role.get(item.role), item.fileAs);
		}
	}

	public void addConfiguredCover(CoverType item) {
		ops.setCover(new File(item.image), item.value);
	}

	public void addConfiguredCoverage(CoverageType coverage) {
		ops.addCoverage(coverage.id, coverage.lang, coverage.text);
	}

	public void addConfiguredCreator(CreatorType item) {
		if (item.role == null) {
			ops.addCreator(item.id, item.lang, item.name, null, item.fileAs);
		} else {
			ops.addCreator(item.id, item.lang, item.name, Role.get(item.role), item.fileAs);
		}
	}

	public void addConfiguredDate(DateType item) {
		ops.addDate(item.id, item.date, item.event);
	}

	/**
	 * The FileSet sub-element is used to add EPUB artifacts that are not a part
	 * of the main text. This can be graphical items and styling (CSS).
	 * 
	 * @param fs
	 *            the fileset to add
	 */
	public void addConfiguredFileSet(FileSetType fs) {
		filesets.add(fs);
	}

	public void addConfiguredFormat(FormatType format) {
		ops.addFormat(format.id, format.text);
	}

	/**
	 * @ant.required
	 */
	public void addConfiguredIdentifier(IdentifierType identifier) {
		ops.addIdentifier(identifier.id, identifier.scheme, identifier.value);
	}

	/**
	 * @ant.required
	 */
	public void addConfiguredItem(ItemType item) {
		ops.addItem(item.id, item.lang, item.file, item.dest, item.type, item.spine, item.linear, item.noToc);
	}

	/**
	 * @ant.required
	 */
	public void addConfiguredLanguage(LanguageType language) {
		ops.addLanguage(language.id, language.code);
	}

	public void addConfiguredMeta(MetaType item) {
		ops.addMeta(item.name, item.content);
	}

	public void addConfiguredPublisher(PublisherType publisher) {
		ops.addPublisher(publisher.id, publisher.lang, publisher.text);
	}

	public void addConfiguredReference(ReferenceType reference) {
		Type type = Type.get(reference.type);
		if (type == null) {
			throw new BuildException("Unknown reference type " + reference.type);
		}
		ops.addReference(reference.href, reference.title, type);
	}

	public void addConfiguredRelation(RelationType relation) {
		ops.addRelation(relation.id, relation.lang, relation.text);
	}

	public void addConfiguredRights(RightsType rights) {
		ops.addRights(rights.id, rights.lang, rights.text);
	}

	public void addConfiguredSource(SourceType source) {
		ops.addSource(source.id, source.lang, source.text);
	}

	public void addConfiguredSubject(SubjectType subject) {
		ops.addSubject(subject.id, subject.lang, subject.text);
	}

	/**
	 * @ant.required
	 */
	public void addConfiguredTitle(TitleType title) {
		ops.addTitle(title.id, title.lang, title.text);
	}

	public void addConfiguredToc(TocType toc) {
		if (this.toc != null) {
			throw new BuildException("Only one table of contents (toc) declaration is allowed.");
		}
		this.toc = toc;
	}

	public void addConfiguredType(org.eclipse.mylyn.docs.epub.ant.TypeType type) {
		ops.addType(type.id, type.text);
	}

	private void addFilesets() {
		for (FileSetType fs : filesets) {
			if (fs.getProject() == null) {
				log("Deleting fileset with no project specified;" + " assuming executing project", Project.MSG_VERBOSE);
				fs = (FileSetType) fs.clone();
				fs.setProject(getProject());
			}
			final File fsDir = fs.getDir();
			if (fsDir == null) {
				throw new BuildException("File or Resource without directory or file specified");
			} else if (!fsDir.isDirectory()) {
				throw new BuildException("Directory does not exist:" + fsDir);
			}
			DirectoryScanner ds = fs.getDirectoryScanner();
			String[] includedFiles = ds.getIncludedFiles();
			for (int i = 0; i < includedFiles.length; i++) {
				String filename = includedFiles[i].replace('\\', '/');
				filename = filename.substring(filename.lastIndexOf("/") + 1);
				File base = ds.getBasedir();
				File found = new File(base, includedFiles[i]);
				ops.addItem(null, fs.lang, found, fs.dest, null, false, true, false);
			}

		}

	}

	@Override
	public void execute() throws BuildException {
		validate();
		addFilesets();
		if (toc != null) {
			if (toc.generate) {
				ops.setGenerateToc(true);
			} else if (toc.file != null) {
				ops.setTableOfContents(toc.file);
			}
		}
		try {
			EPUB epub = new EPUB();
			epub.add(ops);
			if (workingFolder == null) {
				epub.pack(epubFile);
			} else {
				epub.pack(epubFile, workingFolder);
			}

		} catch (Exception e) {
			throw new BuildException(e);
		}
	}

	/**
	 * @ant.not-required Automatically add referenced resources.
	 */
	public void setIncludeReferenced(boolean automatic) {
		ops.setIncludeReferencedResources(automatic);
	}

	/**
	 * 
	 * 
	 * @param file
	 *            path to the generated EPUB file.
	 */
	public void setFile(File file) {
		this.epubFile = file;
	}

	public void setIdentifierId(String identifierId) {
		ops.setIdentifierId(identifierId);
	}

	public void setWorkingFolder(File workingFolder) {
		this.workingFolder = workingFolder;
	}

	private void validate() {
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * @author Torkild U. Resheim
 * @ant.type name="epubfileset" category="epub"
 */
public class FileSetType extends org.apache.tools.ant.types.FileSet {

	String dest;

	Locale lang;

	public FileSetType() {

	}

	public void setLocale(Locale lang) {
		this.lang = lang;
	}

	public void setDest(String dest) {
		this.dest = dest;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

/**
 * @author Torkild U. Resheim
 * @ant.type name="format" category="epub"
 */
public class FormatType {

	String id;

	String text;

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.docs.epub.ant;

/**
 * @author Torkild U. Resheim
 * @ant.type name="identifier" category="epub"
 */
public class IdentifierType {

	String id;

	String scheme;

	String value;

	/**
	 * @ant.required
	 */
	public void addText(String value) {
		this.value = value;
	}

	/**
	 * @ant.required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.required
	 */
	public void setScheme(String scheme) {
		this.scheme = scheme;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.io.File;
import java.util.Locale;

/**
 * @author Torkild U. Resheim
 * @ant.type name="item" category="epub"
 */
public class ItemType {

	String dest;

	File file;

	String id;

	Locale lang;

	/** Default is that items are in reading order */
	public boolean linear = true;

	boolean noToc = false;

	String page;

	/** Default is to add the item to the spine */
	boolean spine = true;

	String type;

	/**
	 * @ant.not-required
	 */
	public void setDest(String dest) {
		this.dest = dest;
	}

	/**
	 * A file on the local file system.
	 * 
	 * @param file
	 * @ant.required
	 */
	public void setFile(File file) {
		this.file = file;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	public void setLang(Locale lang) {
		this.lang = lang;
	}

	public void setLinear(boolean linear) {
		this.linear = linear;
	}

	/**
	 * @ant.not-required
	 */
	public void setNoToc(boolean toc) {
		this.noToc = toc;
	}

	/**
	 * A page on the wiki.
	 * 
	 * @param page
	 */
	public void setPage(String page) {
		this.page = page;
	}

	/**
	 * @ant.not-required
	 */
	public void setSpine(boolean spine) {
		this.spine = spine;
	}

	/**
	 * @ant.not-required
	 */
	public void setType(String type) {
		this.type = type;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

/**
 * @author Torkild U. Resheim
 * @ant.type name="language" category="epub"
 */
public class LanguageType {
	String code;

	String id;

	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.required
	 */
	public void setCode(String code) {
		this.code = code;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

/**
 * @author Torkild U. Resheim
 * @ant.type name="meta" category="epub"
 */
public class MetaType {

	String name;

	String content;

	/**
	 * @ant.required
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * @ant.required
	 */
	public void setContent(String content) {
		this.content = content;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * @author Torkild U. Resheim
 * @ant.type name="publisher" category="epub"
 */
public class PublisherType {

	String id;

	Locale lang;

	String text;

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.not-required
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

/**
 * @author Torkild U. Resheim
 * @ant.type name="reference" category="epub"
 */
public class ReferenceType {

	String href;

	String title;

	String type;

	/**
	 * @ant.required
	 */
	public void setHref(String href) {
		this.href = href;
	}

	/**
	 * @ant.required
	 */
	public void setTitle(String title) {
		this.title = title;
	}

	/**
	 * @ant.required
	 */
	public void setType(String type) {
		this.type = type;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * @author Torkild U. Resheim
 * @ant.type name="relation" category="epub"
 */
public class RelationType {

	String id;

	Locale lang;

	String text;

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.not-required
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * @author Torkild U. Resheim
 * @ant.type name="rights" category="epub"
 */
public class RightsType {

	String id;

	Locale lang;

	String text;

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.not-required
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * @author Torkild U. Resheim
 * @ant.type name="source" category="epub"
 */
public class SourceType {

	String id;

	Locale lang;

	String text;

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.not-required
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * @author Torkild U. Resheim
 * @ant.type name="subject" category="epub"
 */
public class SubjectType {

	String id;

	Locale lang;

	String text;

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.not-required
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.util.Locale;

/**
 * @author Torkild U. Resheim
 * @ant.type name="title" category="epub"
 */
public class TitleType {

	String text;

	Locale lang;

	String id;

	public void setId(String id) {
		this.id = id;
	}

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setLang(Locale lang) {
		this.lang = lang;
	}

}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

import java.io.File;

/**
 * Represents a table of contents element in the {@link EpubTask}. One should
 * specify either a path to a NCX file or whether or not to generate the NCX.
 * 
 * @author Torkild U. Resheim
 * @ant.type name="toc" category="epub"
 */
public class TocType {

	File file;

	boolean generate;

	/**
	 * @ant.not-required
	 */
	public void setFile(File file) {
		this.file = file;
	}

	/**
	 * @ant.not-required
	 */
	public void setGenerate(boolean generate) {
		this.generate = generate;
	}
}




/*******************************************************************************
 * Copyright (c) 2011 Torkild U. Resheim.
 * 
 * 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: Torkild U. Resheim - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.epub.ant;

/**
 * @author Torkild U. Resheim
 * @ant.type name="type" category="epub"
 */
public class TypeType {

	String id;

	String text;

	/**
	 * @ant.required
	 */
	public void addText(String text) {
		this.text = text;
	}

	/**
	 * @ant.not-required
	 */
	public void setId(String id) {
		this.id = id;
	}

}

Lines 1-5 Link Here

(-)a/org.eclipse.mylyn.docs.epub.ant.core/src/org/eclipse/mylyn/docs/epub/ant/tasks.properties (-2 / +2 lines)
1	###############################################################################	1	###############################################################################
2	# Copyright (c) 2011 Torkild U. Resheim	2	# Copyright (c) 2011,2012 Torkild U. Resheim
3	# All rights reserved. This program and the accompanying materials	3	# All rights reserved. This program and the accompanying materials
4	# are made available under the terms of the Eclipse Public License v1.0	4	# are made available under the terms of the Eclipse Public License v1.0
5	# which accompanies this distribution, and is available at	5	# which accompanies this distribution, and is available at
Lines 8-11 Link Here
8	# Contributors:	8	# Contributors:
9	# Torkild U. Resheim - initial API and implementation	9	# Torkild U. Resheim - initial API and implementation
10	###############################################################################	10	###############################################################################
11	epub=org.eclipse.mylyn.docs.epub.ant.EpubTask	11	epub=org.eclipse.mylyn.docs.epub.ant.core.EpubTask




	static ClassLoader classLoader;

	private static final String SIMPLE_FILE_PATH = "test/ant/simple.epub";
	
	private static final String DOC_FILE_PATH = "../org.eclipse.mylyn.docs.epub.help/Building_EPUBs.epub";

	public TestAntTask(String s) {
		super(s);
		classLoader = getClass().getClassLoader();

		assertEpub(SIMPLE_FILE_PATH);
	}

	/**
	 * Tests the "Building EPUBs" book (generated using the Ant task) using the
	 * epub validator. This book is assembled by building the
	 * "org.eclipse.mylyn.docs.epub.ui" bundle. The book contents is converted
	 * from Textile markup to HTML using WikiText.
	 */
	public void testDocumentationBook() {
		File file = getFile(DOC_FILE_PATH);
		assertTrue("Missing publication " + file, file.exists());
		StringWriter sw = new StringWriter();
		PrintWriter pw = new PrintWriter(sw);
		EpubCheck checker = new EpubCheck(file, pw);
		checker.validate();
		Assert.assertTrue(sw.getBuffer().toString().trim(), checker.errorCount == 0);
	}
}

Return to bug 375229

Lines 1-66 Link Here

(-)a/org.eclipse.mylyn.docs.epub.ant.core/src/org/eclipse/mylyn/docs/epub/ant/ContributorType.java (-66 lines)
1	/*******************************************************************************
2	* Copyright (c) 2011 Torkild U. Resheim.
3	*
4	* All rights reserved. This program and the accompanying materials are made
5	* available under the terms of the Eclipse Public License v1.0 which
6	* accompanies this distribution, and is available at
7	* http://www.eclipse.org/legal/epl-v10.html
8	*
9	* Contributors: Torkild U. Resheim - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.mylyn.docs.epub.ant;
12
13	import java.util.Locale;
14
15	/**
16	*
17	* @author Torkild U. Resheim
18	* @ant.type name="contributor" category="epub"
19	*/
20	public class ContributorType {
21
22	String fileAs;
23
24	String id;
25
26	Locale lang;
27
28	String name;
29
30	String role;
31
32	/**
33	* @ant.not-required
34	*/
35	public void setFileAs(String fileAs) {
36	this.fileAs = fileAs;
37	}
38
39	/**
40	* @ant.not-required
41	*/
42	public void setId(String id) {
43	this.id = id;
44	}
45
46	/**
47	* @ant.not-required the language code
48	*/
49	public void setLang(Locale lang) {
50	this.lang = lang;
51	}
52
53	/**
54	* @ant.required name of the contributor
55	*/
56	public void setName(String name) {
57	this.name = name;
58	}
59
60	/**
61	* @ant.not-required
62	*/
63	public void setRole(String role) {
64	this.role = role;
65	}
66	}

Lines 30-38 Link Here

(-)a/org.eclipse.mylyn.docs.epub.tests/src/org/eclipse/mylyn/docs/epub/tests/ant/TestAntTask.java (-18 / +1 lines)
30	static ClassLoader classLoader;	30	static ClassLoader classLoader;
31		31
32	private static final String SIMPLE_FILE_PATH = "test/ant/simple.epub";	32	private static final String SIMPLE_FILE_PATH = "test/ant/simple.epub";
33		33
34	private static final String DOC_FILE_PATH = "../org.eclipse.mylyn.docs.epub.help/Building_EPUBs.epub";
35
36	public TestAntTask(String s) {	34	public TestAntTask(String s) {
37	super(s);	35	super(s);
38	classLoader = getClass().getClassLoader();	36	classLoader = getClass().getClassLoader();
Lines 68-86 Link Here
68	assertEpub(SIMPLE_FILE_PATH);	66	assertEpub(SIMPLE_FILE_PATH);
69	}	67	}
70		68
71	/**
72	* Tests the "Building EPUBs" book (generated using the Ant task) using the
73	* epub validator. This book is assembled by building the
74	* "org.eclipse.mylyn.docs.epub.ui" bundle. The book contents is converted
75	* from Textile markup to HTML using WikiText.
76	*/
77	public void testDocumentationBook() {
78	File file = getFile(DOC_FILE_PATH);
79	assertTrue("Missing publication " + file, file.exists());
80	StringWriter sw = new StringWriter();
81	PrintWriter pw = new PrintWriter(sw);
82	EpubCheck checker = new EpubCheck(file, pw);
83	checker.validate();
84	Assert.assertTrue(sw.getBuffer().toString().trim(), checker.errorCount == 0);
85	}
86	}	69	}