Difference between revisions of "FAQ Can I get my documentation in PDF form, please?"

From Eclipsepedia

Jump to: navigation, search
m
 
Line 1: Line 1:
Documentation for Eclipse SDK releases is available in PDF
+
Documentation for Eclipse SDK releases is available in PDF form from eclipse.org. Obtaining PDF documentation for other Eclipse software, or for non-release builds is a bit more involved.
form from eclipse.org. Obtaining PDF documentation for other Eclipse
+
software, or for non-release builds is a bit more involved.
+
 
+
 
+
 
+
When you download Eclipse code, documentation is provided in the
+
form of HTML files, made accessible through a table of contents
+
contained in a file called <tt>toc.xml</tt>. The contents of the HTML
+
files can be browsed and searched easily with the Eclipse help system
+
(see '''Help &gt; Help Contents'''). The same information can be found online
+
at the Eclipse documentation Web site.
+
 
+
 
+
 
+
Converting HTML to PDF form is somewhat labor-intensive. Although tools are available,
+
such as HTMLDOC, to automatically convert HTML to PDF, the exact selection
+
of files to include in the PDF and in what order requires some extra work.
+
The best approach is to start with the <tt>toc.xml</tt> file and either write a
+
conversion script or develop an Eclipse plug-in, as is done in the <tt>tocviewer</tt>
+
plug-in used to write this book.
+
 
+
 
+
  
 +
When you download Eclipse code, documentation is provided in the  form of HTML files, made accessible through a table of contents  contained in a file called <tt>toc.xml</tt>. The contents of the HTML  files can be browsed and searched easily with the Eclipse help system (see '''Help &gt; Help Contents'''). The same information can be found online at the Eclipse documentation Web site.
  
 +
Converting HTML to PDF form is somewhat labor-intensive. Although tools are available, such as HTMLDOC, to automatically convert HTML to PDF, the exact selection of files to include in the PDF and in what order requires some extra work. The best approach is to start with the <tt>toc.xml</tt> file and either write a conversion script or develop an Eclipse plug-in, as is done in the <tt>tocviewer</tt> plug-in used to write this book.
  
 
== See Also: ==
 
== See Also: ==
 +
*HTMLDOC by Easy Software Products (http://www.easysw.com/htmldoc)
 +
*eclipse.org documentation page (http://www.eclipse.org/documentation)
  
 
+
{{Template:FAQ_Tagline}}
HTMLDOC by Easy Software Products (http://www.easysw.com/htmldoc)
+
 
+
 
+
eclipse.org documentation page
+
 
+
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>
+

Latest revision as of 16:07, 17 June 2006

Documentation for Eclipse SDK releases is available in PDF form from eclipse.org. Obtaining PDF documentation for other Eclipse software, or for non-release builds is a bit more involved.

When you download Eclipse code, documentation is provided in the form of HTML files, made accessible through a table of contents contained in a file called toc.xml. The contents of the HTML files can be browsed and searched easily with the Eclipse help system (see Help > Help Contents). The same information can be found online at the Eclipse documentation Web site.

Converting HTML to PDF form is somewhat labor-intensive. Although tools are available, such as HTMLDOC, to automatically convert HTML to PDF, the exact selection of files to include in the PDF and in what order requires some extra work. The best approach is to start with the toc.xml file and either write a conversion script or develop an Eclipse plug-in, as is done in the tocviewer plug-in used to write this book.

[edit] See Also:


This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.