moved to doc/plan/plan.xml Makefile for transforming plan.xml to html

2004-03-28  Stefan Rotsch  <ritschie@cvs.gnome.org>

  * doc/plan.xml: moved to doc/plan/plan.xml
  * doc/plan/Makefile: Makefile for transforming plan.xml to html
    using xsltproc and xmllint
  * doc/plan/README: README containing some plan-related information
  * doc/plan/ephyplan.dtd: DTD describing plan.xml's content
  * doc/plan/plan.xml: formerly located at doc/plan.xml
  * doc/plan/plan2table.xsl: XSLT stylesheet for plan.xml

5 files changed, 326 insertions, 0 deletions

diff --git a/doc/plan/Makefile b/doc/plan/Makefile
new file mode 100644
index 000000000..aa353ce82
--- /dev/null
+++ b/doc/plan/Makefile
@@ -0,0 +1,14 @@
+SRC = plan.xml
+TARGET = plan.html
+XSLT = plan2table.xsl
+
+all: validate transform
+
+transform:
+	xsltproc --output $(TARGET) $(XSLT) $(SRC)
+
+validate:
+	xmllint --noout --valid $(SRC)
+
+clean:
+	rm -f $(TARGET)
diff --git a/doc/plan/README b/doc/plan/README
new file mode 100644
index 000000000..c5a3d00ae
--- /dev/null
+++ b/doc/plan/README
@@ -0,0 +1,36 @@
+Epiphany Plan README
+
+
+ITEM STATUS INFORMATION
+=======================
+
+Each <item> needs to have a status assigned; possible values are:
+
+    orphan
+    pending
+    delayed
+    designed
+    implementing
+    completed
+
+
+HTML TRANSFORMATION
+===================
+
+The XSLT stylesheet shipped with the plan, plan2table.xsl, will
+transform the plan's XML into a nice HTML table by using:
+
+    xsltproc -o plan.html plan2table.xsl plan.xml
+
+
+VALIDATION
+==========
+
+There's a DTD associated with the Epiphany plan, ephyplan.dtd.
+To prevent typos, you could validate the plan before commiting changes
+to CVS by using:
+
+    xmllint --noout --valid plan.xml
+
+You could also simply run "make" in this directory, which will
+validate the xml input file first, and then transform it to html.
diff --git a/doc/plan/ephyplan.dtd b/doc/plan/ephyplan.dtd
new file mode 100644
index 000000000..51ea07f29
--- /dev/null
+++ b/doc/plan/ephyplan.dtd
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!ELEMENT plan (item*)>
+
+<!ELEMENT item (title,description,status,responsible)>
+<!ELEMENT title (#PCDATA)>
+<!ELEMENT description (#PCDATA)>
+<!ELEMENT status EMPTY>
+<!ELEMENT responsible (#PCDATA)>
+
+<!ATTLIST plan version CDATA #REQUIRED>
+<!ATTLIST status id (completed|delayed|designed|implementing|orphan|pending) #REQUIRED>
+<!ATTLIST responsible email CDATA #REQUIRED>
diff --git a/doc/plan/plan.xml b/doc/plan/plan.xml
new file mode 100644
index 000000000..d4b522f69
--- /dev/null
+++ b/doc/plan/plan.xml
@@ -0,0 +1,210 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<!DOCTYPE plan SYSTEM "ephyplan.dtd">
+<plan version="1.4">

+  <item>

+    <title>Transient/Modal Issues</title>

+    <description>

+      Figure out the transient/modal mess (there must be a guideline somewhere). 

+      Need to consider Mozilla modality problems (network error popups, etc.).

+    </description>

+    <status id="pending"/>

+    <responsible email="marco@gnome.org">Marco Pesenti Gritti</responsible>

+  </item>

+  

+  <item>

+    <title>GNOME Printing Integration</title>

+    <description>

+      Investigate trying to use libgnomeprint[ui]. May need API changes. Find out 

+      from Jody what's in store for gnomeprint 2.8. May not end up with code in 

+      time for 1.4.

+    </description>

+    <status id="pending"/>

+    <responsible email="marco@gnome.org">Marco Pesenti Gritti</responsible>

+  </item>

+  

+  <item>

+    <title>Rethink Toolbar</title>

+    <description>

+      Remove throbber. Combine site icon with address entry (how can we do 

+      dnd for this without mass code-duping).

+    </description>

+    <status id="pending"/>

+    <responsible email="chpe@gnome.org">Christian Persch</responsible>

+  </item>

+  

+  <item>

+    <title>History/Bookmarks Formats</title>

+    <description>

+      Find a better format for History file and drop intermediate bookmarks 

+      file. Need to chat to Edd about extending the RDF. Not essential, but 

+      worth investigating.

+    </description>

+    <status id="pending"/>

+    <responsible email="linux@stefanrotsch.de">Stefan Rotsch</responsible>

+  </item>

+  

+  <item>

+    <title>Finish Lockdown</title>

+    <description>

+      Finish lockdown.

+    </description>

+    <status id="pending"/>

+    <responsible email="clahey@ximian.com">Christopher James Lahey</responsible>

+  </item>

+  

+  <item>

+    <title>Certificates UI</title>

+    <description>

+      Investigate possibility for sys-wide certs UI (share with evolution).

+    </description>

+    <status id="pending"/>

+    <responsible email="piersc@cogs.susx.ac.uk">Piers Cornwell</responsible>

+  </item>

+  

+  <item>

+    <title>GtkMozEmbed</title>

+    <description>

+      Improve gtkmozembed to be more friendly to GNOME.

+    </description>

+    <status id="orphan"/>

+    <responsible email=""></responsible>

+  </item>

+

+  <item>

+    <title>Regional Settings</title>

+    <description>

+      Use system-wide regional settings if it gets in.

+    </description>

+    <status id="pending"/>

+    <responsible email="chpe@gnome.org">Christian Persch</responsible>

+  </item>

+  

+  <item>

+    <title>Extensions Lifecycle</title>

+    <description>

+      Right now the startup process is: &quot;startup -&gt; get session -&gt;

+      get extensions manager -&gt; load extensions -&gt; get session&quot;. We

+      should make the extensions manager load extensions *later*, so that the

+      session is created for them by the time they need it.

+

+      This should pave the way for dynamic loading/unloading of extensions.

+    </description>

+    <status id="pending"/>

+    <responsible email="adamh@densi.com">Adam Hooper</responsible>

+  </item>

+

+  <item>

+    <title>Extensions: Adding Toolbar Buttons</title>

+    <description>

+      Ability for extensions to add toolbar buttons.

+    </description>

+    <status id="pending"/>

+    <responsible email="adamh@densi.com">Adam Hooper</responsible>

+  </item>

+  

+  <item>

+    <title>Extensions: Documentation</title>

+    <description>

+      API and UI guidelines documentation for extensions.

+    </description>

+    <status id="pending"/>

+    <responsible email="adamh@densi.com">Adam Hooper</responsible>

+  </item>

+

+  <item>

+    <title>GNOME Keyring Integration</title>

+    <description>

+      GNOME Keyring integration. Look at Camino and Wallet code. Can use 

+      for http auth and web-form prefill, but NOT for NSS access. Need to 

+      submit Mozilla bugs.

+    </description>

+    <status id="pending"/>

+    <responsible email="chpe@gnome.org">Christian Persch</responsible>

+  </item>

+

+  <item>

+    <title>Nautilus FTP</title>

+    <description>

+      Use Nautilus/gnome-vfs instead of Mozilla to handle the FTP/SFTP protocol.

+      Need to check the shape of the GNOME implementation, see their plans for

+      2.8 and if it makes sense to switch now.

+    </description>

+    <status id="pending"/>

+    <responsible email="xan@gnome.org">Xan Lopez</responsible>

+  </item>

+  

+  <item>

+    <title>Downloader Improvements</title>

+    <description>

+      Misc. improvements for the downloader (nautilus metadata integration, proper

+      duplicated naming, inter-session resume?)

+    </description>

+    <status id="pending"/>

+    <responsible email="xan@gnome.org">Xan Lopez</responsible>

+  </item>

+  

+  <item>

+    <title>Interface for Other Programs</title>

+    <description>

+      Find out what other programs need from us for nice integration -- interfaces.

+    </description>

+    <status id="orphan"/>

+    <responsible email=""></responsible>

+  </item>

+

+  <item>

+    <title>Popup Blocking</title>

+    <description>

+      Popup blocking.

+    </description>

+    <status id="pending"/>

+    <responsible email="marco@gnome.org">Marco Pesenti Gritti</responsible>

+  </item>

+

+  <item>

+    <title>Bookmarks Menu and Toolbars Code</title>

+    <description>

+      Look at improving code to create the bookmarks menu and toolbars.

+    </description>

+    <status id="pending"/>

+    <responsible email="marco@gnome.org">Marco Pesenti Gritti</responsible>

+  </item>

+

+  <item>

+    <title>Completion</title>

+    <description>

+      Completion. Put URI in the address entry when moving through the entry list (like Mozilla).

+    </description>

+    <status id="pending"/>

+    <responsible email="marco@gnome.org">Marco Pesenti Gritti</responsible>

+  </item>

+ 

+  <item>

+    <title>Multihead</title>

+    <description>

+      Implement multi-screen support. Mark gave a detailed explanation

+      of what exactly needs to be done on http://bugzilla.gnome.org/show_bug.cgi?id=112779.

+    </description>

+    <status id="designed"/>

+    <responsible email="marco@gnome.org">Marco Pesenti Gritti</responsible>

+  </item>

+

+  <item>

+    <title>Improve gnome-vfs protocols support</title>

+    <description>

+	In particular it would be nice to be able to save and download

+	to smb://. Mostly mozilla work though.

+    </description>

+    <status id="pending"/>

+    <responsible email="marco@gnome.org">Marco Pesenti Gritti</responsible>

+  </item>

+

+  <item>

+    <title>Quality</title>

+    <description>

+      Work on getting the bug count even lower.

+    </description>

+    <status id="pending"/>

+    <responsible email="piersc@cogs.susx.ac.uk">Piers Cornwell</responsible>

+  </item>

+</plan>

diff --git a/doc/plan/plan2table.xsl b/doc/plan/plan2table.xsl
new file mode 100644
index 000000000..92fc30877
--- /dev/null
+++ b/doc/plan/plan2table.xsl
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:output method="xml" encoding="UTF-8" indent="yes" />
+
+<xsl:template match="/plan">
+    <html><head>
+        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+        <style type="text/css">
+            table { background-color: #EEF; margin: 0 0.5em 1em 0.5em; }
+            .blank { padding: 0.5em 0; }
+            .title { background-color: #669; color: #FFF; font-size: 1.2em; font-weight: bold; padding: 0 0.25em; text-align: left; }
+            .description {background-color: #CAA; padding: 0.25em 0.5em; text-align: left; }
+            .responsible { white-space: nowrap; }
+            .status { padding: 0.25em 1em; text-align: center; }
+            .completed { background-color: #0F0; color: #FFF; }
+            .delayed { background-color: #909; color: #FFF; }
+            .designed { background-color: #F60; color: #FFF; }
+            .implementing { background-color: #FF0; color: #FFF; }
+            .orphan { background-color: #00F; color: #FFF; }
+            .pending { background-color: #F00; color: #FFF; }
+        </style>
+    </head><body>
+        <h1>Epiphany <xsl:value-of select="@version" /> Plan</h1>
+<table>
+        <xsl:apply-templates select="item">
+            <!-- Sort by status first, then sort by title (both alphabetically)-->
+            <xsl:sort select="status/@id" />
+            <xsl:sort select="title" />
+        </xsl:apply-templates>
+</table>
+    </body></html>
+</xsl:template>
+
+<xsl:template match="item">
+    <tr>
+        <td class="title" colspan="2"><xsl:value-of select="title" /></td>
+    </tr>
+    <tr>
+        <td class="description"><xsl:value-of select="description" />
+        <span class="responsible">
+            <xsl:if test="normalize-space(responsible)">
+                    [<a href="mailto:{responsible/@email}"><xsl:value-of select="responsible" /></a>]
+            </xsl:if>
+        </span>
+        </td>
+        <td class="status"><span class="{status/@id}"><xsl:value-of select="status/@id" /></span></td>
+    </tr>
+    <tr>
+        <td class="blank" colspan="2"></td>
+    </tr>
+</xsl:template>
+
+</xsl:stylesheet>