Difference between revisions of "Create Local Manual"

From Audacity Wiki
Jump to: navigation, search
m (Manual - Zipping and Uploading)
(Link.)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Template:Audacity Devel}}
 
{{Template:Audacity Devel}}
 
+
{{Introrel|1=This page describes how to prepare the local help for Audacity(R).|2=If the advice here is inaccurate or incomplete, please email audacity-devel_AT_lists_DOT_sourceforge_DOT_net.|3=
 
 
{{Introrel|1=This page describes how to prepare the local help for Audacity(R).|2=If the advice here is inaccurate or incomplete, please e-mail audacity-devel_AT_lists_DOT_sourceforge_DOT_net.|3=
 
 
  [[Release Process]]
 
  [[Release Process]]
* [[Developing On Windows]] }}
+
* [[Building On Windows]]
 +
* [[Building The Manual]]
 +
}}
  
 
== Manual - Building ==
 
== Manual - Building ==
Line 17: Line 17:
  
 
== Manual - Testing ==
 
== Manual - Testing ==
 +
(Note: This is no longer required for 'official' releases since it will be done as part of the preparatory phase.)
 +
 
Test the unzipped manual using http://linkchecker.sourceforge.net/ or similar, and report errors/warnings as appropriate.
 
Test the unzipped manual using http://linkchecker.sourceforge.net/ or similar, and report errors/warnings as appropriate.
  
Line 23: Line 25:
  
 
# Zip the result of the above as audacity-manual-<versionrcX>.zip (for example audacity-manual-2.0.1rc1.zip). When unzipped, it should produce a "help" folder with the "manual" folder inside that.
 
# Zip the result of the above as audacity-manual-<versionrcX>.zip (for example audacity-manual-2.0.1rc1.zip). When unzipped, it should produce a "help" folder with the "manual" folder inside that.
# Upload the audacity-manual-<versionrcX>.zip onto Google code http://code.google.com/p/audacity for use by the people making installers etc.
+
# Upload the audacity-manual-<versionrcX>.zip onto drop box for use by the people making installers etc.
 
# Mark any previous rc as 'Deprecated'.
 
# Mark any previous rc as 'Deprecated'.
 
# Make sure that people are aware of the upload, and any new ones that are done, including
 
# Make sure that people are aware of the upload, and any new ones that are done, including
Line 31: Line 33:
 
When the release happens, rename audacity-manual-<versionrcX>.zip as the final version (for example audacity-manual-2.0.1.zip).
 
When the release happens, rename audacity-manual-<versionrcX>.zip as the final version (for example audacity-manual-2.0.1.zip).
  
== Unused/optional step ==
+
==Manual Freeze and Unfreeze==
(The following step has not been used for recent Win builds, but has been left here for historical reasons.)
+
Manual should not be unfrozen until 'all bases are covered'
 
+
* Copy of zipped manual obtained for distribution.
A currently optional step, at least for beta builds, is to reduce the size of the manual by reducing the size of the .png files.  A way to do this on Windows with ImageMagick installed is shown as a batch script below, started from the image directory:
+
* Static copy of manual updated on website.
  
  FOR /R %%a IN (*.png) DO mogrify -posterize 64 %%a
+
== Colour depth of images should probably be addressed in the manual ==
  FOR /R %%a IN (*.png) DO convert -quality 90 %%a %%a
+
There used to be a suggestion here that we reduced the color count and optimise the images of the manual.
 +
* This is now done automatically be the varnish caching at audacityteam.org.
 +
* If we want to we can in future do this using PIL and python.
  
This reduces the number of colors to 64 and then uses a hint to the .png compressor to be aggressive about compression.  The %%a works on Win7.  Martyn found that %a was needed instead on his platform (Win XP?).  This reduces total images size from about 12Mb to about 5.2Mb.  Some of the largest files are already being replaced on the wiki.  If we do the whole wiki, then this step can be removed.  If someone wants to post the equivalent script for Linux that would be appreciated.
 
  
 
[[Category:For Developers]][[Category:Quality]]
 
[[Category:For Developers]][[Category:Quality]]

Latest revision as of 19:10, 15 September 2018


This page describes how to prepare the local help for Audacity(R).
If the advice here is inaccurate or incomplete, please email audacity-devel_AT_lists_DOT_sourceforge_DOT_net.
 
Related article(s):

Manual - Building

These instructions are for Windows, but the basics are the same for any platform. We use a script to pull the manual from the wiki and turn it into static html.

Remove the old manual and make sure you can rebuild a new one:

  1. Make sure you have Python installed and on your PATH. Use version 2.7.*, not 3.2.*.
  2. Delete audacity\help\manual if it exists.
  3. On VS, the manual can be built in audacity\help\manual by building the 'help' project.
  4. On Windows if you just want to get the manual, go to audacity\scripts\mw2html_audacity, run wiki2htm and wait for it to complete.
  5. There is also a wiki2htm.sh, which may still work (untested here, feel free to update this comment)

Manual - Testing

(Note: This is no longer required for 'official' releases since it will be done as part of the preparatory phase.)

Test the unzipped manual using http://linkchecker.sourceforge.net/ or similar, and report errors/warnings as appropriate.

Manual - Zipping and Uploading

For a Release, somebody should follow these instructions just after the 'manual freeze' so that builders have the same manual for all OSs. That person will be agreed as part of the Release Process.

  1. Zip the result of the above as audacity-manual-<versionrcX>.zip (for example audacity-manual-2.0.1rc1.zip). When unzipped, it should produce a "help" folder with the "manual" folder inside that.
  2. Upload the audacity-manual-<versionrcX>.zip onto drop box for use by the people making installers etc.
  3. Mark any previous rc as 'Deprecated'.
  4. Make sure that people are aware of the upload, and any new ones that are done, including
    1. RM
    2. People making installers etc.

When the release happens, rename audacity-manual-<versionrcX>.zip as the final version (for example audacity-manual-2.0.1.zip).

Manual Freeze and Unfreeze

Manual should not be unfrozen until 'all bases are covered'

  • Copy of zipped manual obtained for distribution.
  • Static copy of manual updated on website.

Colour depth of images should probably be addressed in the manual

There used to be a suggestion here that we reduced the color count and optimise the images of the manual.

  • This is now done automatically be the varnish caching at audacityteam.org.
  • If we want to we can in future do this using PIL and python.