You are here: Foswiki>Tasks Web>Item8812 (25 Mar 2017, GeorgeClark)Edit Attach

Item8812: ship text version of INSTALL.html

pencil
Priority: Enhancement
Current State: No Action Required
Released In: n/a
Target Release: n/a
Applies To: Engine
Component: Documentation
Branches:
Reported By: WillNorris
Waiting For:
Last Change By: GeorgeClark
because "installing a software product on a server shouldn't requiring keeping a browser open".

-- WillNorris - 31 Mar 2010

Looking around trying to find a perl parser that would convert from HTML to plain text. So far the best I've found is to either use less and redirect the output to a file. It creates a text file, extracts all links and converts them to footnotes at the bottom of the file.

Lavr, this would be pretty simple if we use less, however it would restrict the build to linux platforms, an possibly the version of less.

-- GeorgeClark - 13 Mar 2011

This is an RM issue, so changing feedback to George.

-- Main.CrawfordCurrie - 20 Jun 2015 - 09:03

This builds the text files:

diff --git a/core/tools/build.pl b/core/tools/build.pl
index 322e852..494c136 100755
--- a/core/tools/build.pl
+++ b/core/tools/build.pl
@@ -452,6 +452,9 @@ sub stage_gendocs {
         "$this->{tmpDir}/ReleaseNotes01x02.html",
         "$this->{tmpDir}/ReleaseNotes01x02.html"
     );
+    `lynx -dump $this->{tmpDir}/ReleaseNotes01x02.html > $this->{tmpDir}/ReleaseNotes01x02.txt`;
+    `lynx -dump $this->{tmpDir}/UpgradeGuide.html > $this->{tmpDir}/UpgradeGuide.txt`;
+    `lynx -dump $this->{tmpDir}/INSTALL.html > $this->{tmpDir}/INSTALL.txt`;
     print "Automatic documentation built\n";
 }
 

Not sure how useful they are though

-- GeorgeClark - 21 Jun 2015

Changing this to no-action. Nobody seems to be making much of a fuss.

-- GeorgeClark - 25 Mar 2017
 

ItemTemplate edit

Summary ship text version of INSTALL.html
ReportedBy WillNorris
Codebase
SVN Range
AppliesTo Engine
Component Documentation
Priority Enhancement
CurrentState No Action Required
WaitingFor
Checkins
TargetRelease n/a
ReleasedIn n/a
CheckinsOnBranches
trunkCheckins
masterCheckins
ItemBranchCheckins
Release02x01Checkins
Release02x00Checkins
Release01x01Checkins
Topic revision: r5 - 25 Mar 2017, GeorgeClark
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy