History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: LPP-4539
Type: Task Task
Status: Closed Closed
Resolution: Fixed
Priority: P1 P1
Assignee: Frisco Del Rosario
Reporter: Benjamin Shine
Votes: 0
Watchers: 1
Operations

If you were logged in you would be able to see more operations.
OpenLaszlo

Put in a header in each page of reference guide saying "this is an alpha; please look elsewhere(link) for better docs"

Created: 20/Aug/07 04:52 PM   Updated: 25/Oct/07 10:36 AM
Component/s: Doc Tools
Affects Version/s: 4.0.5WaffleCone
Fix Version/s: 4.0.5WaffleCone

Time Tracking:
Not Specified

Severity: Minor
Fixed in Change#: 6,369
Runtime: N/A
Fix in hand: False


 Description  « Hide
Pages of the OL4 reference guide should have a header at the top, explaining that these are alpha docs and that we recommend viewing the 3.4 docs on www.openlaszlo.org/lps3/docs

 All   Comments   Work Log   Change History      Sort Order: Ascending order - Click to sort in descending order
John Sundman - 23/Aug/07 02:10 PM
How about this wording:

"The OpenLaszlo 4.x Reference Manual is alpha quality. The information on this page is believed to be correct, but some information may be missing. We recommend using the OpenLaszlo 3.4 Reference Manual, since the APIs are essential identical between OL 3.4 and OL 4.x. The OpenLaszlo 4.0.5 Developer's Guide should be used in preference to the OL 3.4 Developer's Guide, however."


Something like that?

Amy Muntz - 28/Aug/07 07:55 AM
Lou - please change the text line to "Documentation in progress - please use the 3.4 Reference Manual"

Benjamin Shine - 30/Aug/07 03:05 PM
I'm going to take this because it looks like it's going to be a regexp/perl kind of solution, not a docbook solution, and I really want to do it.

Benjamin Shine - 31/Aug/07 03:59 PM
Partial fixes in r6313:

Change 20070831-ben-S by ben@slim.local on 2007-08-31 15:54:42 PDT
    in /Users/ben/src/svn/openlaszlo/branches/wafflecone-doctools/docs
    for http://svn.openlaszlo.org/openlaszlo/branches/wafflecone/docs

Summary: Add CSS to make don't-read-this snippet in ref guide obnoxiously pink

New Features:

Bugs Fixed: LPP-4539 (partial) Put in a header in each page of reference guide saying "this is an alpha; please look elsewhere(link) for better docs

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

Documentation:
This change adds two CSS styles to the lzx stylesheet used in the
reference guide, to make the "don't-read-this" snippet be pink,
in order to draw attention to itself. This will not change the
way anything looks until something with class="warningheader" is
inserted into the ref guide, which is happening separately, elsewhere.

Release Notes:
This style can be removed after wafflecone.

Details:
    

Tests:

Benjamin Shine - 04/Sep/07 10:58 AM
Change to docs/src/build.xml sent to ptw for review.

Benjamin Shine - 05/Sep/07 05:35 PM

Change 20070904-ben-t by ben@slim.local on 2007-09-04 10:52:29 PDT
    in /Users/ben/src/svn/openlaszlo/branches/wafflecone
    for http://svn.openlaszlo.org/openlaszlo/branches/wafflecone

Summary: Add a doc build step to insert a disclaimer

New Features:

Bugs Fixed: LPP-4539 Put in a header in each page of reference guide saying "this is an alpha; please look elsewhere(link) for better docs"

Technical Reviewer: ptw
QA Reviewer: mkratt (pending)
Doc Reviewer: sundman (pending)

Documentation:

This change adds a step to the documentation build process to insert a
disclaimer into every page of the reference manual saying, roughly,
please go use the 3.4 reference. After building the whole docs,
it calls the new ant target "reference.html.disclaimer" which in turn
calls a shell script in $LZ_TOOLS_ROOT which inserts the disclaimer
right after the header in every reference page.

This change should NOT be merged back to legals; it should ONLY
be in wafflecone for the 4.0.5 release.

The script invoked by this change is checked in to
http://svn.openlaszlo.org/tools/trunk/injector/injector.sh

Release Notes:

Details:
    

Tests:
ant doc
Look at http://localhost:8080/wafflecone/docs/reference/index.html
it should have a big pink disclaimer at the top.

Steve O'Sullivan - 25/Oct/07 10:36 AM
Verified in 4.0.6 release that the header exists in the Developer's Guide.