yelp-tools is an open source and free command-line software designed as part of the Yelp project, providing the necessary scripts for generating, maintaining and publishing documentation for the GNOME desktop environment.
The program can also be used to publish documentation on the Internet. It is comprised of various scripts, such as yelp-check and yelp-build, as well as an yelp.m4 file that provides autotools integration.
What is Yelp?
Yelp is an open source, free and very useful software project, a collection of documentation utilities for the GNOME desktop environment, containing a set of utilities for building documentation.
The Yelp project also contains the yelp-xsl utility, which provides core XSLT stylesheets used by libyelp and Yelp itself, as well as the libyelp GTK+ library, which makes it easy to build a help viewer, or embed one in an application.
Getting started yelp-tools
Usually, yelp-tools can be installed through the package manager of your GNU/Linux distribution, but it gets automatically installed with Yelp, when installing the GNOME desktop environment.
It can also be used on other open-source desktop environments. To install and use the yelp-tools package on your distro, first check if a pre-built binary package is available on the main software repositories.
If not, download the latest stable version from Softoware, save the archive on your PC, preferably your Home directory, extract its contents using an archive manager tool, open a Terminal app and navigate to the location of the extracted archive files (e.g. cd /home/softoware/yelp-tools-3.14.1).
Arrived at the location of the extracted archive files, run the ‘./configure && make’ command to configure and compile the program, followed by the ‘sudo make install’ command to install it system wide.
The commands are available through the Yelp software or directly from the command-line interface, using a terminal emulator.
What is new in this release:
- Adapt to recent major changes in yelp-xsl
- yelp.m4: Disable net access in make check
- yelp-check: Add --jing option to validate command to use jing
- yelp-check: Add style command to list page styles
- yelp-check: Remember URLs we already checked in `hrefs`
What is new in version :
- yelp-check: Sites support for orphans, links, media, status
What is new in version 3.17.3:
- yelp.m4: Fixed issues with make distcheck and install not running correclty unless make is run first, #701959 and #738142 (Sebastian Geiger)
What is new in version 3.11.5:
- yelp-build: Added -i option to ignore missing media files
- yelp-build: Added -p option to provide path for external files
- yelp-build: Set LC_ALL instead of LANG for awk, #709354
- yelp-check: Added check for missing media files
- yelp-check: Added tool to check Mallard page licenses
- yelp.m4: Use AS_HELP_STRING instead of AC_HELP_STRING, #709657
What is new in version 3.11.3:
- yelp.m4: no-lc-dist option to disable disting the generated lc files (Christian Persch)
What is new in version 3.11.2:
- yelp.m4: Added no-lc-media-links option for YELP_HELP_INIT
- yelp.m4: Reverted HELP_MEDIA_NODUP and YELP_INIT_HELP
Requirements:
- yelp-xsl
Comments not found