[Laszlo-checkins] r7904 - in openlaszlo/trunk/docs: includes src src/nav src/reference

[dda@openlaszlo.org]

Author: dda
Date: 2008-01-28 08:15:09 -0800 (Mon, 28 Jan 2008)
New Revision: 7904

Added:
   openlaszlo/trunk/docs/src/reference/wrappers.xml
Modified:
   openlaszlo/trunk/docs/includes/docbook.css
   openlaszlo/trunk/docs/src/build.xml
   openlaszlo/trunk/docs/src/nav/toc.xml
Log:
Change 20080128-dda-A by dda at lester.local on 2008-01-28 10:27:08 EST
    in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: doc: added ref pages for HTML elements and Media

New Features:

Bugs Fixed: LPP-4931 (partial), LPP-4932 (partial)

Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)

Documentation: 

Release Notes:

Details:
    Content for these items is not extracted from classes,
    like most of the other reference doc.  For example, there is no class
    to implement the HTML <br> tag.  The content for this was kept separately
    in files in the wrappers/ directory.  Since this was in a slightly different
    format, this change copies the needed content into a file 'wrappers.xml'
    in the new format, changes the build.xml to know about this new file.
    The table of contents is updated to reference the new entries, and the
    exposed 'TODO' has been removed from the navigation.  Some slight
    adjustment to the content to find the resources they need to work right.
    A small style sheet change was needed to address the issue of when
    there is no synopsis (like this content).

    The static (non-live) examples do not seem to be shown correctly, but
    that is a universal problem that will be dealt in another change.

    Also not included is the content for two font pages, LzAudio
    (need to hunt these down).  Also LzFontManager is currently (purposely)
    omitted.  This is currently marked as a private class, although it
    apparently has a legitimate use, discussion is ongoing.
    TODOs for these items left in comments in toc.xml, but not shown.

Tests:



Modified: openlaszlo/trunk/docs/includes/docbook.css
===================================================================
--- openlaszlo/trunk/docs/includes/docbook.css	2008-01-28 15:42:25 UTC (rev 7903)
+++ openlaszlo/trunk/docs/includes/docbook.css	2008-01-28 16:15:09 UTC (rev 7904)
@@ -64,6 +64,7 @@
     left:60%;
     max-width: 40%;
     margin-top: -80px;
+    min-height: 80px;
     padding: 5pt;
     text-align: right; 
 }

Modified: openlaszlo/trunk/docs/src/build.xml
===================================================================
--- openlaszlo/trunk/docs/src/build.xml	2008-01-28 15:42:25 UTC (rev 7903)
+++ openlaszlo/trunk/docs/src/build.xml	2008-01-28 16:15:09 UTC (rev 7904)
@@ -329,7 +329,7 @@
     <copy todir="${local.output.dir}/resources" failonerror="false">
       <fileset dir="${local.build.dir}/resources"/>
     </copy>
-  	
+
     <mkdir dir="${developers.output.dir}/includes"/>
     <copy todir="${developers.output.dir}/includes" failonerror="false">
       <fileset dir="${docs.output.dir}/includes"/>
@@ -565,9 +565,17 @@
       <param name="merge.file" expression="${reference.build.dir}/embednew.xml"/>
     </style>
     
+    <style style="xsl/js2doc-append.xsl"
+           in="${reference.build.dir}/LaszloLibrary-4.js2doc"
+           out="${reference.build.dir}/LaszloLibrary-5.js2doc">
+      <xmlcatalog refid="commonDTDs"/>
+      <xmlcatalog refid="docbook.local.xsl"/>
+      <param name="merge.file" expression="${reference.src.dir}/wrappers.xml"/>
+    </style>
+    
     <!-- make certain information explicit to ease processing by js2doc2dbk.xsl -->
     <style style="xsl/js2doc-verbose.xsl"
-           in="${reference.build.dir}/LaszloLibrary-4.js2doc"
+           in="${reference.build.dir}/LaszloLibrary-5.js2doc"
            out="${reference.build.dir}/LaszloLibrary-verbose.js2doc">
       <xmlcatalog refid="commonDTDs"/>
       <xmlcatalog refid="docbook.local.xsl"/>

Modified: openlaszlo/trunk/docs/src/nav/toc.xml
===================================================================
--- openlaszlo/trunk/docs/src/nav/toc.xml	2008-01-28 15:42:25 UTC (rev 7903)
+++ openlaszlo/trunk/docs/src/nav/toc.xml	2008-01-28 16:15:09 UTC (rev 7904)
@@ -101,12 +101,27 @@
     
     
     <category title="HTML Markup">
-        <item title="TODO [BUG LPP-4931]" />
         <item title="LzTextFormat" href="lz.LzTextFormat.html" />
+        <item title="a" href="tag-a.html"/>
+        <item title="b" href="tag-b.html"/>
+        <item title="br" href="tag-br.html"/>
+        <!-- TODO: [2008-01-28 dda] <item title="font" href="tag-font.html"/> -->
+        <item title="i" href="tag-i.html"/>
+        <item title="img" href="tag-img.html"/>
+        <item title="p" href="tag-p.html"/>
+        <item title="pre" href="tag-pre.html"/>
+        <item title="u" href="tag-u.html"/>
     </category>
     
     <category title="Media" >
-        <item title="TODO [BUG LPP-4932]" />
+        <item title="audio" href="tag-audio.html"/>
+        <!-- TODO: [2008-01-28 dda] <item title="font (LzFont)" href="lz.LzFont.html" /> -->
+        <item title="face" href="tag-face.html"/>
+        <item title="frame" href="tag-frame.html"/>
+        <item title="image" href="lz.image.html"/>
+        <!-- TODO: [2008-01-28 dda] <item title="LzAudio" href="lz.LzAudio.html" /> -->
+        <item title="resource" href="tag-resource.html"/>
+        <!-- LzFontManager ???  -->
     </category>
     
     <category title="Data">

Added: openlaszlo/trunk/docs/src/reference/wrappers.xml


Property changes on: openlaszlo/trunk/docs/src/reference/wrappers.xml
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native