Script for generating parodies of bad documentation
- From: Dave Malcolm <dmalcolm redhat com>
- To: gnome-doc-devel-list gnome org
- Cc: dogtail-devel-list gnome org
- Subject: Script for generating parodies of bad documentation
- Date: Thu, 13 Oct 2005 02:05:26 -0400
I've been a bad, bad, person and written this dogtail [1] script:
http://cvs.gnome.org/viewcvs/dogtail/examples/no-help-at-all.py?view=markup
You pass it the accessible name of a running application, and it scours
that application's GUI, reading it back to you in DocBook form.
The idea is (i) to parody some of the unhelpful user documentation I've
seen over the years - please don't write documentation that looks like
this! This was inspired in part by reading Shaun McCance's Project
Mallard notes here: http://www.gnome.org/~shaunm/quack/mallard.xml
(ii) to provide a source of test data for help viewers, such as Yelp,
and for stylesheet authors
Attached is an example of the output when I pointed the script at gedit.
My apologies...
[1] http://people.redhat.com/zcerza/dogtail/index.html
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
<article>
<articleinfo>
<title>The Totally Definitive No-Nonsense Unhelpful Complete Guide to <application>gedit</application> for Mannequins in 40 Days - Unleashed!</title>
</articleinfo>
<sect1>
<title>Introduction</title>
<caution><para>Do not take these instructions seriously. They are a parody of unhelpful help files found on many computer systems, and were autogenerated by <application>no-help-at-all</application></para></caution>
<para>You can start <application>gedit</application> by opening a terminal and typing the <command>gedit</command> command.</para>
</sect1>
<sect1>
<title>The <guimenu>File</guimenu> menu</title>
<para>Use the <guimenu>File</guimenu> menu to work with files</para>
<sect2>
<title>Newing a file</title>
<para>To new a file, choose <guimenu>File</guimenu> > <guimenuitem>New</guimenuitem></para>
</sect2>
<sect2>
<title>Open...ing a file</title>
<para>To open... a file, choose <guimenu>File</guimenu> > <guimenuitem>Open...</guimenuitem></para>
</sect2>
<sect2>
<title>Open Location...ing a file</title>
<para>To open location... a file, choose <guimenu>File</guimenu> > <guimenuitem>Open Location...</guimenuitem></para>
</sect2>
<sect2>
<title>Saveing a file</title>
<para>To save a file, choose <guimenu>File</guimenu> > <guimenuitem>Save</guimenuitem></para>
</sect2>
<sect2>
<title>Save As...ing a file</title>
<para>To save as... a file, choose <guimenu>File</guimenu> > <guimenuitem>Save As...</guimenuitem></para>
</sect2>
<sect2>
<title>Reverting a file</title>
<para>To revert a file, choose <guimenu>File</guimenu> > <guimenuitem>Revert</guimenuitem></para>
</sect2>
<sect2>
<title>Page Setuping a file</title>
<para>To page setup a file, choose <guimenu>File</guimenu> > <guimenuitem>Page Setup</guimenuitem></para>
</sect2>
<sect2>
<title>Print Preview...ing a file</title>
<para>To print preview... a file, choose <guimenu>File</guimenu> > <guimenuitem>Print Preview...</guimenuitem></para>
</sect2>
<sect2>
<title>Print...ing a file</title>
<para>To print... a file, choose <guimenu>File</guimenu> > <guimenuitem>Print...</guimenuitem></para>
</sect2>
<sect2>
<title>1. No-Help-At-All.Pying a file</title>
<para>To 1. no-help-at-all.py a file, choose <guimenu>File</guimenu> > <guimenuitem>1. no-help-at-all.py</guimenuitem></para>
</sect2>
<sect2>
<title>2. Tmp.Xmling a file</title>
<para>To 2. tmp.xml a file, choose <guimenu>File</guimenu> > <guimenuitem>2. tmp.xml</guimenuitem></para>
</sect2>
<sect2>
<title>3. Tree.Pying a file</title>
<para>To 3. tree.py a file, choose <guimenu>File</guimenu> > <guimenuitem>3. tree.py</guimenuitem></para>
</sect2>
<sect2>
<title>4. Test-Docbook.Xmling a file</title>
<para>To 4. test-docbook.xml a file, choose <guimenu>File</guimenu> > <guimenuitem>4. test-docbook.xml</guimenuitem></para>
</sect2>
<sect2>
<title>5. Abiword-Test.Pying a file</title>
<para>To 5. abiword-test.py a file, choose <guimenu>File</guimenu> > <guimenuitem>5. abiword-test.py</guimenuitem></para>
</sect2>
<sect2>
<title>Closeing a file</title>
<para>To close a file, choose <guimenu>File</guimenu> > <guimenuitem>Close</guimenuitem></para>
</sect2>
<sect2>
<title>Quiting a file</title>
<para>To quit a file, choose <guimenu>File</guimenu> > <guimenuitem>Quit</guimenuitem></para>
</sect2>
</sect1>
<sect1>
<title>The <guimenu>Edit</guimenu> menu</title>
<para>Use the <guimenu>Edit</guimenu> menu to work with edits</para>
<sect2>
<title>Undoing a edit</title>
<para>To undo a edit, choose <guimenu>Edit</guimenu> > <guimenuitem>Undo</guimenuitem></para>
</sect2>
<sect2>
<title>Redoing a edit</title>
<para>To redo a edit, choose <guimenu>Edit</guimenu> > <guimenuitem>Redo</guimenuitem></para>
</sect2>
<sect2>
<title>Cuting a edit</title>
<para>To cut a edit, choose <guimenu>Edit</guimenu> > <guimenuitem>Cut</guimenuitem></para>
</sect2>
<sect2>
<title>Copying a edit</title>
<para>To copy a edit, choose <guimenu>Edit</guimenu> > <guimenuitem>Copy</guimenuitem></para>
</sect2>
<sect2>
<title>Pasteing a edit</title>
<para>To paste a edit, choose <guimenu>Edit</guimenu> > <guimenuitem>Paste</guimenuitem></para>
</sect2>
<sect2>
<title>Deleteing a edit</title>
<para>To delete a edit, choose <guimenu>Edit</guimenu> > <guimenuitem>Delete</guimenuitem></para>
</sect2>
<sect2>
<title>Select Alling a edit</title>
<para>To select all a edit, choose <guimenu>Edit</guimenu> > <guimenuitem>Select All</guimenuitem></para>
</sect2>
<sect2>
<title>Preferencesing a edit</title>
<para>To preferences a edit, choose <guimenu>Edit</guimenu> > <guimenuitem>Preferences</guimenuitem></para>
</sect2>
</sect1>
<sect1>
<title>The <guimenu>View</guimenu> menu</title>
<para>Use the <guimenu>View</guimenu> menu to work with views</para>
</sect1>
<sect1>
<title>The <guimenu>Customise Toolbar</guimenu> menu</title>
<para>Use the <guimenu>Customise Toolbar</guimenu> menu to work with customise toolbars</para>
</sect1>
<sect1>
<title>The <guimenu>Highlight Mode</guimenu> menu</title>
<para>Use the <guimenu>Highlight Mode</guimenu> menu to work with highlight modes</para>
</sect1>
<sect1>
<title>The <guimenu>Sources</guimenu> menu</title>
<para>Use the <guimenu>Sources</guimenu> menu to work with sourcess</para>
</sect1>
<sect1>
<title>The <guimenu>Scripts</guimenu> menu</title>
<para>Use the <guimenu>Scripts</guimenu> menu to work with scriptss</para>
</sect1>
<sect1>
<title>The <guimenu>Markup</guimenu> menu</title>
<para>Use the <guimenu>Markup</guimenu> menu to work with markups</para>
</sect1>
<sect1>
<title>The <guimenu>Others</guimenu> menu</title>
<para>Use the <guimenu>Others</guimenu> menu to work with otherss</para>
</sect1>
<sect1>
<title>The <guimenu>Search</guimenu> menu</title>
<para>Use the <guimenu>Search</guimenu> menu to work with searchs</para>
<sect2>
<title>Find...ing a search</title>
<para>To find... a search, choose <guimenu>Search</guimenu> > <guimenuitem>Find...</guimenuitem></para>
</sect2>
<sect2>
<title>Find Nexting a search</title>
<para>To find next a search, choose <guimenu>Search</guimenu> > <guimenuitem>Find Next</guimenuitem></para>
</sect2>
<sect2>
<title>Find Previousing a search</title>
<para>To find previous a search, choose <guimenu>Search</guimenu> > <guimenuitem>Find Previous</guimenuitem></para>
</sect2>
<sect2>
<title>Replace...ing a search</title>
<para>To replace... a search, choose <guimenu>Search</guimenu> > <guimenuitem>Replace...</guimenuitem></para>
</sect2>
<sect2>
<title>Go To Line...ing a search</title>
<para>To go to line... a search, choose <guimenu>Search</guimenu> > <guimenuitem>Go to Line...</guimenuitem></para>
</sect2>
</sect1>
<sect1>
<title>The <guimenu>Tools</guimenu> menu</title>
<para>Use the <guimenu>Tools</guimenu> menu to work with toolss</para>
<sect2>
<title>Check Spellinging a tools</title>
<para>To check spelling a tools, choose <guimenu>Tools</guimenu> > <guimenuitem>Check Spelling</guimenuitem></para>
</sect2>
<sect2>
<title>Set Languageing a tools</title>
<para>To set language a tools, choose <guimenu>Tools</guimenu> > <guimenuitem>Set Language</guimenuitem></para>
</sect2>
</sect1>
<sect1>
<title>The <guimenu>Documents</guimenu> menu</title>
<para>Use the <guimenu>Documents</guimenu> menu to work with documentss</para>
<sect2>
<title>Save Alling a documents</title>
<para>To save all a documents, choose <guimenu>Documents</guimenu> > <guimenuitem>Save All</guimenuitem></para>
</sect2>
<sect2>
<title>Close Alling a documents</title>
<para>To close all a documents, choose <guimenu>Documents</guimenu> > <guimenuitem>Close All</guimenuitem></para>
</sect2>
<sect2>
<title>Move To New Windowing a documents</title>
<para>To move to new window a documents, choose <guimenu>Documents</guimenu> > <guimenuitem>Move to New Window</guimenuitem></para>
</sect2>
<sect2>
<title>Gedit-Test-Results.Txting a documents</title>
<para>To gedit-test-results.txt a documents, choose <guimenu>Documents</guimenu> > <guimenuitem>gedit-test-results.txt</guimenuitem></para>
</sect2>
<sect2>
<title>Test-Docbook.Xmling a documents</title>
<para>To test-docbook.xml a documents, choose <guimenu>Documents</guimenu> > <guimenuitem>test-docbook.xml</guimenuitem></para>
</sect2>
<sect2>
<title>Tmp.Xmling a documents</title>
<para>To tmp.xml a documents, choose <guimenu>Documents</guimenu> > <guimenuitem>tmp.xml</guimenuitem></para>
</sect2>
<sect2>
<title>Tree.Pying a documents</title>
<para>To tree.py a documents, choose <guimenu>Documents</guimenu> > <guimenuitem>tree.py</guimenuitem></para>
</sect2>
<sect2>
<title>No-Help-At-All.Pying a documents</title>
<para>To no-help-at-all.py a documents, choose <guimenu>Documents</guimenu> > <guimenuitem>no-help-at-all.py</guimenuitem></para>
</sect2>
</sect1>
<sect1>
<title>The <guimenu>Help</guimenu> menu</title>
<para>Use the <guimenu>Help</guimenu> menu to work with helps</para>
<sect2>
<title>Contentsing a help</title>
<para>To contents a help, choose <guimenu>Help</guimenu> > <guimenuitem>Contents</guimenuitem></para>
</sect2>
<sect2>
<title>Abouting a help</title>
<para>To about a help, choose <guimenu>Help</guimenu> > <guimenuitem>About</guimenuitem></para>
</sect2>
</sect1>
</article>
[Date Prev][
Date Next] [Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
