PPTools/Guiguts/Guiguts Tool Updates

From DPWiki
Jump to navigation Jump to search

Introduction

There are several tools bundled with Guiguts, particularly with the Windows release. Some of these tools are maintained externally and are not under the direct control of the Guiguts maintenance team. Examples are the Nu HTML Checker and ebookmaker, both of which are available as online tools in addition to the local versions bundled with Guiguts. This means that from time to time, a tool may be updated and released online when there is no plan for a new release of Guiguts. With a little effort, it is possible to update some of these tools to the latest version yourself, though you should be aware that there is potential for a mismatch between the new version of the tool and the version of Guiguts you are running. When there is a significant change that may be useful to Guiguts users, a member of the Guiguts maintenance team will attempt to notify users via the forums. Advanced users may also wish to update their tools at other times at their own risk. The purpose of this page is to give instructions on how to update the local version of several tools.

Ebookmaker

Ebookmaker has its own GitHub repository, where the developers collaborate, develop, document and store the tool. However, although the latest release of the ebookmaker Python script is available there for users who have Python installed (typically Linux and Mac users, though Windows users are able to install Python), that script will not be useful for a typical Windows Guiguts user. The Guiguts team will therefore convert ebookmaker from its Python script form into a Windows ".exe" program which is compatible with Guiguts on Windows systems - this is called "ebm_builder". The following instructions are therefore for Windows users only.

  1. Go to the ebm_builder releases page.
  2. The latest release will be at the top of the list - its version number corresponds directly to the version number of ebookmaker used to create it.
  3. Directly below the release description, under "Assets", download the ebookmaker zip file, e.g. by right clicking and choosing "Save link as".
  4. Unzip this file on your computer - inside it you will find ebookmaker.exe.
  5. Make sure the old ebookmaker.exe in your release is safe, in case you want to return to it, as follows: Go to guiguts\tools\ebookmaker; rename ebookmaker.exe to ebookmaker_safe.exe, or something similar.
  6. Copy the new ebookmaker.exe that you unzipped earlier into the guiguts\tools\ebookmaker folder.

Nu HTML Checker

The Nu HTML Checker (or validator) also has a GitHub repository. Unfortunately, it is not being released in dated pre-built forms in the same way as some other tools. Instead it is being "tagged" on certain dates, but to use these you will need to build the vnu.jar file yourself - see below for outline instructions.

There is however a "latest" release, which you could download at your own risk: note that this is a development version, is not necessarily the version being used online, and may contain bugs. To get this latest (pre-release) pre-built version:

  1. Go to the validator releases page.
  2. The release at the top of the list is named "latest" and labelled "Pre-release".
  3. Directly below the release description, under "Assets", download the vnu.jar zip file, e.g. by right clicking and choosing "Save link as".
  4. Unzip this file on your computer - inside it you will find a folder named dist, and in that a file vnu.jar.
  5. Make sure the old vnu.jar in your release is safe, in case you want to return to it, as follows: Go to guiguts\tools\W3C; rename vnu.jar to vnu_safe.jar, or something similar.
  6. Copy the new vnu.jar that you unzipped earlier into the guiguts\tools\W3C folder.

Alternatively, if you are confident with using Git, Python and shell commands, then you can download and build a tagged version as follows:

  1. Go to the validator tags page.
  2. Note the tag number - referred to below as TAG
  3. Create an empty temporary directory where the system can build the new version - referred to below as TEMPDIRNAME
  4. Execute the following in a shell (MSYS2 - Mingw64, not Mingw32, works under Windows)
    1. git clone --branch TAG https://github.com/validator/validator.git TEMPDIRNAME
    2. cd TEMPDIRNAME
    3. python ./checker.py update-shallow build jar - this takes quite a while and creates build/dist/vnu.jar
  5. Copy build/dist/vnu.jar into the guiguts\tools\W3C folder after you have taken a safe copy of the version currently there.

EPUBCheck

EPUBCheck also has a GitHub repository. To update to the latest version follow the instructions below:

  1. Go to the EPUBCheck releases page.
  2. The release at the top of the list might be labelled "Pre-release". Unless you are confident that this is the version you want, ignore it - it has not been officially released, and may contain bugs. Instead, find the first release in the list that is not a pre-release; it will probably have the label "Latest".
  3. Directly below the release description, under "Assets", download the epubcheck zip file, e.g. by right clicking and choosing "Save link as".
  4. Unzip this file on your computer - inside it you will find a folder named epubcheck-VERSION, where VERSION will be some numbers, like "4.2.6".
  5. Make sure the old EPUBCheck in your release is safe, in case you want to return to it, as follows: Go to guiguts\tools\W3C; rename the folder epubcheck to epubcheck_safe, or something similar.
  6. Copy the new epubcheck-VERSION folder that you unzipped earlier into the guiguts\tools\W3C folder.
  7. IMPORTANT: Rename the new folder you have just copied to plain epubcheck

CSS Validator

The CSS Validator also has a GitHub repository. To update to the latest version follow the instructions below:

  1. Go to the CSS Validator releases page.
  2. The release at the top of the list might be labelled "Pre-release". Unless you are confident that this is the version you want, ignore it - it has not been officially released, and may contain bugs. Instead, find the first release in the list that is not a pre-release; it will probably have the label "Latest".
  3. Directly below the release description, under "Assets", download the css-validator.jar file, e.g. by right clicking and choosing "Save link as".
  4. Make sure the old CSS Validator in your release is safe, in case you want to return to it, as follows: Go to guiguts\tools\W3C; rename css-validator.jar to css-validator_safe.jar, or something similar.
  5. Copy the new css-validator.jar folder that you downloaded earlier into the guiguts\tools\W3C folder.

Additional dictionaries for Spell Query

  1. Go to the Guiguts supplementary materials page.
  2. Find the language you want - note that English, French and German are included with the Guiguts release anyway.
  3. Download the relevant zip file.
  4. Unzip the file - it will contain a file named dict_LANG_user.txt, where LANG is the two letter language code.
  5. Copy the dict_LANG_user.txt file to your GGprefs folder (recommended). Alternatively, you can put it in the "data" folder under the release if you do not have a GGprefs folder.
  6. Restart Guiguts and ensure the project language is set correctly to pick up the new dictionary