/usr/share/doc/ne/html/General-Guidelines.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>ne&rsquo;s manual: General Guidelines</title>

<meta name="description" content="ne&rsquo;s manual: General Guidelines">
<meta name="keywords" content="ne&rsquo;s manual: General Guidelines">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="Command-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Commands.html#Commands" rel="up" title="Commands">
<link href="File-Commands.html#File-Commands" rel="next" title="File Commands">
<link href="Commands.html#Commands" rel="prev" title="Commands">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="General-Guidelines"></a>
<div class="header">
<p>
Next: <a href="File-Commands.html#File-Commands" accesskey="n" rel="next">File Commands</a>, Up: <a href="Commands.html#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="Command-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="General-Guidelines-1"></a>
<h3 class="section">4.1 General Guidelines</h3>
<a name="index-Long-names"></a>
<a name="index-Short-names"></a>
<a name="index-Command-arguments"></a>
<a name="index-Flags-2"></a>
<a name="index-Repeating-actions"></a>
<a name="index-Escape-conventions"></a>
<a name="index-Quoting-conventions"></a>

<p>Every command in <code>ne</code> has a long and a short name. Except in a very
few cases, the short name is given by two or three letters that are the
initials of the words that form the long name. For instance,
<code>SearchBack</code> has short name <code>SB</code>, <code>SaveDefPrefs</code> has the
short name <code>SDP</code>, and <code>AdjustView</code>&rsquo;s short name is <code>AV</code>.
There are some exceptions however. The most frequently used commands
such as <code>Exit</code> have one-letter short names (<code>X</code>). Also some
commands use a different short name to avoid clashes with a more common
command&rsquo;s short name. For example, <code>StatusBar</code>&rsquo;s short name is
<code>ST</code> rather than <code>SB</code>  to avoid clashes with
<code>SearchBack</code>&rsquo;s short name.
</p>
<p>A command always has at most one argument. This is a chosen limitation
that allows <code>ne</code>&rsquo;s parsing of commands and macros to be very fast.
Moreover, it nullifies nearly all problems related to delimiters, escape
characters, and the like. The unique argument can be a number, a string,
or a flag modifier. You can easily distinguish these three cases even
without this manual by looking at what the <code>Help</code> command says
about the given command. Note that when a command&rsquo;s argument is enclosed
in square brackets, it is optional.
</p>
<p>Strings are general purpose arguments. Numbers are used to modify internal
parameters, such as the size of a <small>TAB</small>. A flag modifier is an optional
number that is interpreted as follows:
</p>
<ul>
<li> 0 means clearing the flag;

</li><li> 1 (or any positive number) means setting the flag;

</li><li> no number means toggling the flag.

</li></ul>

<p>Thus, <code>StatusBar 1</code> will activate that status bar, while <code>I</code> will
toggle insert/overstrike. This design choice is due to the fact that most of
the time during interactive editing you need to <em>change</em> a
flag. For instance, you may be in insert mode and you want to overstrike, or
vice versa. Absolute settings (those with a number) are useful essentially
for macros. It is reasonable to use the fastest approach for the most
frequent interactive event. When a number or a string is required and the
argument is optional, most of the time you will be prompted to
type the argument on the command line.
</p>
<p>As for the input line, for numeric arguments you can choose between
decimal, octal and hexadecimal notation in the standard way:
a number starting with &lsquo;<samp>0</samp>&rsquo; is considered in octal, a number
starting with &lsquo;<samp>0x</samp>&rsquo; is considered in hexadecimal, and in all other
cases decimal base is assumed.
</p>
<p>When a number represents how many times <code>ne</code> should repeat an
action, it is always understood that the command will terminate when the
conditions for applying it are no longer true. For instance, the
<code>Paragraph</code> command accepts the number of paragraphs to format.
But if not enough paragraphs exists in the text, only the available ones
will be formatted.
</p>
<p>This easily allows performing operations on an entire document by specifying
preposterously huge numbers as arguments. <code>ToUpper 200000000</code> will
make all the words in the document upper case. (At least, one would
hope so!) Note that this is much faster than recording a macro with
the command <code>ToUpper</code> in it and playing it many times because in
the former case the command has to be parsed just one time.
</p>
<p>In any case, if a macro or a repeated operation takes too long, you can stop
it using the interrupt key (<kbd><span class="key">Control</span>-\</kbd>).
</p>

<p>To handle situations such as an argument string starting with a
space, <code>ne</code> implements a simple mechanism whereby you can enclose
any string argument in double quotes. If the first non-blank character
after the command and last character of the command line are double
quotes, the quotes will be removed and whatever is left will be used as
the string argument. For example, the <code>Find</code> command to find a
space could be entered on the command line or in a macro as
<code>Find &quot; &quot;</code>. The only case needing special treatment is
when a string starts and ends with double quotes. The command
<code>Find &quot;&quot;quote&quot;&quot;</code> would locate the next occurrence of the string
&lsquo;<samp>&quot;quote&quot;</samp>&rsquo; (including the double quotes). However,
<code>Find onequote&quot;</code> wouldn&rsquo;t require special treatment because the
command argument doesn&rsquo;t both start and end with a double quote.
</p>



<hr>
<div class="header">
<p>
Next: <a href="File-Commands.html#File-Commands" accesskey="n" rel="next">File Commands</a>, Up: <a href="Commands.html#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="Command-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
ne-doc 3.0.1-2build1 / usr / share / doc / ne / html / General-Guidelines.html
