[petsc-dev] adding Report Typo and Errors link to manual pages

Mon Jan 6 15:53:03 CST 2014

On Mon, 6 Jan 2014, Jed Brown wrote:

> Satish Balay <balay at mcs.anl.gov> writes:
> 
> > How about: http://ftp.mcs.anl.gov/pub/petsc/tmp/VecView.html
> >
> > [perhaps 'MANUALPAGE' can be changed to 'documentation' - if we are doing this for all docs.]
> 
> The message should come preformatted to include the URL of the page on
> which a typo is being reported.  I would also reduce the font size a
> little.

I can add in <small> formatting for the text.

But wrt URL - since we don't know where the docs will land - I can add
in the following context to the message:

Please describe the typo or error in the documentation: petsc-VER GIT-ID FILE-NAME

i.e

Please describe the typo or error in the documentation: petsc-dev 06283fd4323cef45a7147b2226c8e0c084e2a1d2 docs/manualpages/Vec/VecView.html

http://ftp.mcs.anl.gov/pub/petsc/tmp/VecView.html is updated

Satish


------------

$ git diff |cat

diff --git a/makefile b/makefile
index 362c004..44d50cf 100644
--- a/makefile
+++ b/makefile
@@ -335,11 +335,13 @@ docsetdate: chk_petscdir
         fi; \
         datestr=`git log -1 --pretty=format:%ci | cut -d ' ' -f 1`; \
         export datestr; \
+        gitver=`git log -1 --pretty=format:%H`; \
+        export gitver; \
         find * -type d -wholename src/docs/website -prune -o -type d -wholename src/benchmarks/results -prune -o \
           -type d -wholename config/BuildSystem/docs/website -prune -o -type d -wholename include/web -prune -o \
           -type d -wholename 'arch-*' -prune -o -type d -wholename src/tops -prune -o -type d -wholename externalpackages -prune -o \
           -type f -wholename tutorials/multiphysics/tutorial.html -prune -o -type f -name \*.html \
-          -exec perl -pi -e 's^(<body.*>)^$$1\n   <div id=\"version\" align=right><b>$$ENV{petscversion} $$ENV{datestr}</b></div>^i' {} \; \
+          -exec perl -pi -e 's^(<body.*>)^$$1\n   <div id=\"version\" align=right><b>$$ENV{petscversion} $$ENV{datestr}</b></div>\n   <div id="bugreport" align=right><a href="mailto:petsc-maint at mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: $$ENV{petscversion} $$ENV{gitver} {} "><small>Report Typos and Errors</small></a></div>^i' {} \; \
           -exec perl -pi -e 's^(<head>)^$$1 <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/{}" />^i' {} \; ; \
         echo "Done fixing version number, date, canonical URL info"

