[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: More .cvsignore entries?

From: Robert J. Chassell
Subject: Re: More .cvsignore entries?
Date: Tue, 16 Jul 2002 12:28:39 +0000 (UTC)

   > BTW, I'm mildly annoyed at the use of @copying ...
   > Is @copying really important ?

Yes, it is important.

It turned out that documents in various output types, in particular
HTML, were being published *without* any copyright or permissions
notice.  People forgot to put them in.

This meant that people were forbidden to copy, much less modify, much
GNU documentation except for fair use.

This failure was inadvertent:  the people who wrote documentation --
just about everyone who wrote documentation -- provided copying
notices for the `older' cases, for Texinfo itself, for Info, and for
DVI (and deriviatives such as PDF); but they simply forgot HTML!

The @copying command and its companion, @insertcopying,
enable everyone to insert proper copying text.

Here is a sample template that illustrates the use of @copying and
@insertcopying.  It also illustrates, I hope, a proper *verbatim*

(There is some continued discussion concerning the wording of a
verbatim license; for example, it probably does not matter whether you
include the phrase `without royalty' -- the GNU Web site does not:


but the license is more clear if you do include the phrase.)

(For modifiable works, please use the GNU Free Documentation License.
It was cleverly crafted to mean the same ordinary people, lawyers, and
judges, and to be acceptable to many hard copy publishers as well as
to people who favor freedom.)

Also, this template includes 6 different shell commands for formatting
the file.  It includes XML and DocBook output.

I put these commands into an @ignore ... @end ignore section near the
beginning of the file.  These commands are very useful.  (Since I
mostly work in an X windowing system, I simply copy them from the
Emacs window in which I am editing the Texinfo file into an xterm and
run them.)

I urge you to edit your Texinfo file in GNU Emacs using Texinfo mode.
The mode simplifies your work.  For example, I use the `C-u C-c C-u
C-a' (texinfo-all-menus-update) command all the time.  I never update
node pointers or write menus myself.

Best wishes

    Robert J. Chassell                  address@hidden
    Rattlesnake Enterprises             http://www.rattlesnake.com

Here is the sample template:

\input texinfo.tex                         @c -*-texinfo-*-
@comment %**start of header
@setfilename test.info
@settitle Texinfo Test
@comment %**end of header

 ## Summary of shell commands to create various output formats:

    ## Info output
    makeinfo --force --fill-column=70 --no-split --paragraph-indent=0 \
    --verbose test.texi

    ## DVI output
    texi2dvi test.texi

    ## Plain text output
    makeinfo --fill-column=70 --no-split --paragraph-indent=0 \
    --verbose --no-headers --output=test.txt  \

    ## HTML output
    makeinfo --no-split --html test.texi

    ## DocBook output
    makeinfo --docbook --no-split --paragraph-indent=0 \
    --verbose test.texi

    ## XML output
    makeinfo --xml --no-split --paragraph-indent=0 \
    --verbose test.texi

@end ignore

Copyright @copyright{} 2002 Robert J. Chassell

This is a test document.

Permission is granted to make and distribute verbatim copies
of this entire document without royalty provided the
copyright notice and this permission notice are preserved on
all copies.

@c    The remainder of this paragraph applies to and should
@c    appear in the Texinfo source.
@c Permission is granted to process this file through TeX or
@c other converter and publish the results, provided the
@c published document carries a copying permission notice
@c identical to this one except for the removal of this
@c paragraph (this paragraph not being relevant to the
@c published document).

Permission is granted to copy and distribute translations
of this document into another language, except that this
permission notice may be stated in a translation approved
by the Free Software Foundation.
@end quotation
@end copying

@c For smallbook format, use smaller than normal amounts of
@c whitespace between chapters, sections, and paragraphs.
@c Remember to comment this out if you are not using smallbook format!
\global\chapheadingskip = 15pt plus 4pt minus 2pt
\global\secheadingskip = 12pt plus 3pt minus 2pt
\global\subsecheadingskip = 9pt plus 2pt minus 2pt \global\parskip 2pt plus 1pt
@end tex

@sp 6
@center @titlefont{Test document}
@sp 4
@center by Robert J. Chassell

@vskip 0pt plus 1filll
@end titlepage


@node Top, Chapter One, (dir), (dir)
@top Test Top
@end ifnottex

* Chapter One::
* Chapter Two::
@end menu

@node Chapter One, Chapter Two, Top, Top
@comment node, next, prev, up
@chapter Chapter One

Contents of chapter 1.

The quick brown fox jumps over the lazy dog.

The quick brown fox jumps over the lazy dog.

Here is an bulleted list:

@itemize @bullet

First item.

Second item.
@end itemize

@node Chapter Two,  , Chapter One, Top
@chapter Chapter Two

Contents of chapter 2
@cindex bar

The lazy dog opened an eye.

* Section TwoA::
* Section TwoB::
@end menu

@node Section TwoA, Section TwoB, Chapter Two, Chapter Two
@section SectionTwoA

Contents of Section 2A

The quick brown fox jumps over the lazy dog.

(+ 2 2)
@end smallexample

@node Section TwoB,  , Section TwoA, Chapter Two
@section Section TwoB

Contents of Section 2B

The lazy dog jumps over the quick brown fox.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]