Skip to content

Commit

Permalink
docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@scottslewis
scottslewis committed Mar 13, 2011
1 parent 27719fc commit 6e52384
Show file tree
Hide file tree
Showing 8 changed files with 160 additions and 155 deletions.
6 changes: 4 additions & 2 deletions doc/bundles/org.eclipse.ecf.doc/build.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ bin.includes = plugin.xml,\
topics_GettingStarted.xml,\
tocapi.xml,\
toc.xml,\
schema.xml
schema.xml,\
topics_Reference_RemoteServices.xml
src.includes = intro/,\
about.html,\
notices.html,\
Expand All @@ -26,7 +27,8 @@ src.includes = intro/,\
tocpics_Concepts.xml,\
tocapi.xml,\
toc.xml,\
schema.xml
schema.xml,\
topics_Reference_RemoteServices.xml
bin.excludes = html/reference/api/
generateSourceBundle=false

12 changes: 6 additions & 6 deletions doc/bundles/org.eclipse.ecf.doc/buildapitoc.xml
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
<project default="toc" basedir=".">

<target name="init">
<property name="package-list.path" location="${basedir}/html/reference/api/package-list"/>
<uptodate property="BuildAPITOC.uptodate" srcfile="${package-list.path}" targetfile="BuildAPITOC.class"/>
</target>

<target name="toc" depends="init,compile">
<echo file="tocapi.xml"><![CDATA[
<toc label="JavaDoc">
]]></echo>
<java classname="BuildAPITOC" classpath="." output="tocapi.xml" append="true">
<arg value="${package-list.path}"/>
<arg value="http://download.eclipse.org/rt/ecf/3.5Test/javadoc/package-list"/>
</java>
<echo file="tocapi.xml" append="true"><![CDATA[
</toc>
]]></echo>
</target>

<target name="compile" unless="BuildAPITOC.uptodate">
<target name="compile">
<echo file="BuildAPITOC.java"><![CDATA[
import java.io.*;
import java.net.URL;
public class BuildAPITOC {
public static void main(String[] args) throws Exception {
System.out.println("args[0] is "+args[0]);
BufferedReader r = new BufferedReader(new FileReader(args[0]));
URL url = new URL(args[0]);
BufferedReader r = new BufferedReader(new InputStreamReader(url.openStream()));
String line;
try {
while ((line = r.readLine()) != null)
System.out.println("<topic label=\"" + line + "\" href=\"http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/" + line.replace('.', '/') + "/package-summary.html\"/>");
System.out.println("<topic label=\"" + line + "\" href=\"http://download.eclipse.org/rt/ecf/3.5Test/javadoc/" + line.replace('.', '/') + "/package-summary.html\"/>");
} finally {
r.close();
}
Expand Down
8 changes: 8 additions & 0 deletions doc/bundles/org.eclipse.ecf.doc/plugin.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@
<toc file="topics_Reference.xml"/>
<toc file="topics_Extpoint.xml"/>
<toc file="topics_Tutorials.xml"/>
<toc
file="tocapi.xml"
primary="false">
</toc>
<toc
file="topics_Reference_RemoteServices.xml"
primary="false">
</toc>
</extension>


Expand Down
14 changes: 7 additions & 7 deletions doc/bundles/org.eclipse.ecf.doc/toc.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
<?NLS TYPE="org.eclipse.help.toc"?>

<toc label="ECF Developer Guide" link_to="toc.xml">
<topic label="Quick Start" href="html/gettingstarted/quickStart.html"/>
<topic label="OSGi 4.2 Remote Services" href="http://wiki.eclipse.org/ECF#OSGi_4.2_Remote_Services"/>
<topic label="System Requirements" href="html/gettingstarted/prerequisites.html"/>
<topic label="Overview" href="html/gettingstarted/ecf_overview.html"/>
<topic label="Tips and Tricks" href="http://wiki.eclipse.org/ECF_Tips_Tricks"/>
<topic label="What's New and Noteworthy" href="http://www.eclipse.org/ecf/NewAndNoteworthy.html"/>
<topic label="Legal" href="notices.html"/>
<topic label="Programmer's Reference">
<topic label="Project Blog" href="http://eclipseecf.blogspot.com/"/>
<topic label="OSGi Remote Services" href="http://wiki.eclipse.org/ECF#OSGi_Remote_Services">
<link toc="topics_Reference_RemoteServices.xml"/>
</topic>
<topic label="Distributed Event Admin" href="http://wiki.eclipse.org/Distributed_EventAdmin_Service"/>
<topic label="Generic Servers" href="http://wiki.eclipse.org/ECF_Servers"/>
<topic label="Reference">
<anchor id="reference"/>
</topic>
<topic label="Tutorials">
Expand Down
248 changes: 113 additions & 135 deletions doc/bundles/org.eclipse.ecf.doc/tocapi.xml
View file

Large diffs are not rendered by default.

15 changes: 11 additions & 4 deletions doc/bundles/org.eclipse.ecf.doc/topics_Reference.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@
<?NLS TYPE="org.eclipse.help.toc"?>

<toc label="Reference" link_to="toc.xml#reference">
<topic label="Introduction" href="html/concepts/intro.html"/>
<topic label="OSGi 4.2 Remote Services" href="http://wiki.eclipse.org/ECF#OSGi_4.2_Remote_Services"/>
<topic label="What's New and Noteworthy" href="http://www.eclipse.org/ecf/NewAndNoteworthy.html"/>
<topic label="ECF Architecture" href="http://www.eclipse.org/ecf/documentation.php"/>
<topic label="ECF API" href="http://wiki.eclipse.org/index.php/ECF_API_Docs"/>
<topic label="JavaDoc" href="http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/overview-summary.html"/>
<topic label="Project Wiki" href="http://wiki.eclipse.org/index.php/Eclipse_Communication_Framework_Project"/>
<topic label="API JavaDoc" href="http://download.eclipse.org/rt/ecf/3.5Test/javadoc">
<link toc="tocapi.xml"/>
</topic>
<topic label="Homepage" href="http://www.eclipse.org/ecf"/>
<topic label="Summary" href="http://www.eclipse.org/projects/project_summary.php?projectid=rt.ecf"/>
<topic label="Wiki" href="http://wiki.eclipse.org/ECF"/>
<topic label="Mailing List" href="https://dev.eclipse.org/mailman/listinfo/ecf-dev"/>
<topic label="Newsgroup" href="http://www.eclipse.org/forums/index.php"/>
<topic label="IP Log" href="http://www.eclipse.org/projects/ip_log.php?projectid=rt.ecf"/>
<topic label="Project Blog" href="http://eclipseecf.blogspot.com/"/>
<topic label="Extension Points">
<link toc="topics_Extpoint.xml"/>
</topic>
Expand Down
10 changes: 10 additions & 0 deletions doc/bundles/org.eclipse.ecf.doc/topics_Reference_RemoteServices.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="OSGi Remote Services">
<topic label="REST API" href="http://wiki.eclipse.org/REST_abstraction_for_ECF"/>
<topic label="Getting Started with OSGi Remote Services" href="http://wiki.eclipse.org/Getting_Started_with_ECF%27s_OSGi_Remote_Services_Implementation"/>
<topic label="Remote Services Admin" href="http://wiki.eclipse.org/Remote_Services_Admin"/>
<topic label="Asynchronous Proxies" href="http://wiki.eclipse.org/Asynchronous_Proxies_for_Remote_Services"/>
<topic label="OSGi Remote Services and ECF" href="http://wiki.eclipse.org/OSGi_4.2_Remote_Services_and_ECF"/>
<topic label="File-based Discovery of Remote Services" href="http://wiki.eclipse.org/File-based_Discovery"/>
</toc>
2 changes: 1 addition & 1 deletion doc/bundles/org.eclipse.ecf.doc/topics_Tutorials.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
<topic label="Distributed EventAdmin Service" href="http://wiki.eclipse.org/Distributed_EventAdmin_Service"/>
<topic label="Real-Time Shared Editing" href="http://wiki.eclipse.org/DocShare_Plugin"/>
<topic label="Create an IRC bot" href="html/tutorials/bot.html"/>
<topic label="Other Info" href="http://wiki.eclipse.org/Eclipse_Communication_Framework_Project"/>
<topic label="Other Info" href="http://wiki.eclipse.org/ECF"/>
</toc>

0 comments on commit 6e52384

Please sign in to comment.