Attachment 9447 Details for Bug 21060 – Summary of functionality tests on helloworld.yo

Summary of functionality tests on helloworld.yo

yodling (text/plain), 2.71 KB, created by Len Lawrence on 2017-06-28 10:24:24 CEST

(hide)

Description:

Filename:

MIME Type:

Creator: Len Lawrence

Created: 2017-06-28 10:24:24 CEST

Size: 2.71 KB

patch

obsolete

>This summary outlines some simple tests of yodl's capabilities for the purpose of QA.
>Disclaimer: Some of this is interpretation so please excuse any uncertainties expressed here.
> 
>The tests use an original file referenced in an article by Larry Ayers in an old issue of Linux Gazette - http://www.tldp.org/LDP/LG/issue09/yodl.html - and the attached helloworld.yo file is extracted from his text, edited slightly in a couple of places to prepare it for more recent versions of yodl.  Lewis has found a good starting point for documentation at https://fbb-git.github.io/yodl/ and http://yodl.sourceforge.net/yodl04.html#l109 describes how to prepare a man page as a yodl document, including  a description of the general format. 
>
>A suite of utilities provide conversions of yodl scripts to a number of common text document formats such as HTML, XML and LaTeX as shown below.  yodl by itself merely echoes the text to standard output, stripped of comments.  /usr/share/yodl/ has a number of resource files containing macros and definitions specific to particular document types, files like html.yo and std.html.yo, probably read in by yodl and yodlpost during processing. 
>
>$ yodl2html helloworld.yo
>This generates helloworld.html which can be viewed directly in a browser.
>The -t commandline switch can be used to help with the construction and debugging of new files, providing a rolling trace to standard error output during execution, similar to bare yodl parsing but will presumably contain error reports for any faulty directives.  An index file may be generated as well, to be used by yodlpost which is called as necessary from yodl  In most of these tests you will see "no post-processing required" and no index (.idx) file will be generated.  
>
>The other tests follow the same pattern.
>
>$ yodl2man helloworld.yo
>produced nroff tagged output suitable for a man page.
>$ cat helloworld.man
>.TH "Test article for YODL" "1996"
>.PP
>
>.SH "Test article for YODL"
>
>.SH "Karel Kubat"
>
>.SH "1996"
>..............................
>  
>yodl2txt produces bare text as expected; i.e. the original with formatting instructions removed, extension .txt.
>
>yodl2latex creates a LaTeX file.  You need to install latex to use the typesetting tool.
>$ yodl2latex -w helloworld.yo
>The -w switch suppresses warnings.  Output is in the form of a LaTeX file which can be further processed to give an impression of how the printed page would look.  There are problems with the specimen file and version 3 of yodl so expect some erors.
>$ latex helloworld.latex
>$ dvi2tty helloworld.dvi
>This shows the typeset page in the console, or at least an impression of it.
>
>$ yodl2xml helloworld.yo
>generates legitimate XML code which can be viewed with highlighting in vim, emacs, gedit or kate.
>
>
>
>
>
>

This summary outlines some simple tests of yodl's capabilities for the purpose of QA.
Disclaimer: Some of this is interpretation so please excuse any uncertainties expressed here.
 
The tests use an original file referenced in an article by Larry Ayers in an old issue of Linux Gazette - http://www.tldp.org/LDP/LG/issue09/yodl.html - and the attached helloworld.yo file is extracted from his text, edited slightly in a couple of places to prepare it for more recent versions of yodl.  Lewis has found a good starting point for documentation at https://fbb-git.github.io/yodl/ and http://yodl.sourceforge.net/yodl04.html#l109 describes how to prepare a man page as a yodl document, including  a description of the general format. 

A suite of utilities provide conversions of yodl scripts to a number of common text document formats such as HTML, XML and LaTeX as shown below.  yodl by itself merely echoes the text to standard output, stripped of comments.  /usr/share/yodl/ has a number of resource files containing macros and definitions specific to particular document types, files like html.yo and std.html.yo, probably read in by yodl and yodlpost during processing. 

$ yodl2html helloworld.yo
This generates helloworld.html which can be viewed directly in a browser.
The -t commandline switch can be used to help with the construction and debugging of new files, providing a rolling trace to standard error output during execution, similar to bare yodl parsing but will presumably contain error reports for any faulty directives.  An index file may be generated as well, to be used by yodlpost which is called as necessary from yodl  In most of these tests you will see "no post-processing required" and no index (.idx) file will be generated.  

The other tests follow the same pattern.

$ yodl2man helloworld.yo
produced nroff tagged output suitable for a man page.
$ cat helloworld.man
.TH "Test article for YODL" "1996"
.PP

.SH "Test article for YODL"

.SH "Karel Kubat"

.SH "1996"
..............................
  
yodl2txt produces bare text as expected; i.e. the original with formatting instructions removed, extension .txt.

yodl2latex creates a LaTeX file.  You need to install latex to use the typesetting tool.
$ yodl2latex -w helloworld.yo
The -w switch suppresses warnings.  Output is in the form of a LaTeX file which can be further processed to give an impression of how the printed page would look.  There are problems with the specimen file and version 3 of yodl so expect some erors.
$ latex helloworld.latex
$ dvi2tty helloworld.dvi
This shows the typeset page in the console, or at least an impression of it.

$ yodl2xml helloworld.yo
generates legitimate XML code which can be viewed with highlighting in vim, emacs, gedit or kate.

Actions: View

Attachments on bug 21060: 9432 | 9447 | 9448