[ADD] add man.conf, view with most.

[arrow.git] / conf_slk120 / vim / _vim / doc / utl_ref.txt

*utl_ref.txt* Plugin for executing URLs from text files (reference manual)\r
For Vim version 6, Version: utl-2.0, $Revision: 1.1.1.1 $\r
\r
                    Utl.vim Reference Manual\r
\r
                         By Stefan Bittner\r
                        stb@bf-consulting.de\r
\r
        Contents:\r
\r
                1. The utl.vim reference........|utl-reference-manual|\r
                2. Brief refresher URL and URI..|utl-uriprim|\r
\r
NOTE: At the moment (utl.vim-2.0) the reference is not complete.\r
\r
References:\r
- see |utlusr.txt| for the user manual\r
\r
==============================================================================\r
1. The utl.vim reference                            *utl-reference-manual*\r
\r
1.1 Fragment expression syntax                          *utl-fragexpr*\r
\r
Utl.vim supports the following fragment expressions:\r
\r
#tn=MySearchText      "Text Next Search"                *utl-#tn*\r
#MySearchText         Addresses that position in the target file, which is\r
                      defined by searching the string "MySearchText" in\r
                      forward direction.\r
                      The search is done relative, i.e. beginning from the\r
                      actual position. This typically is the start of the\r
                      document.  MySearchText can contain White Space.  The\r
                      searching is done in a fuzzy manner (see\r
                      <URL:../plugin/utl.vim#r=fuzzy>).  The basic idea of the\r
                      fuzzy search is that the semantic sequence of words\r
                      should be sufficient, in order to minimize broken\r
                      fragments.\r
\r
#tp=MySearchText      "Text Previous Search"                *utl-#tp*\r
                      like #tn but search backwards.\r
\r
#line=MyLineNumber    e.g. line=23, line=-8.                *utl-#line*\r
                      References the given line number in the text.\r
                      The search is done relative, like above.\r
\r
#r=MyIdentifier       ID-Reference.                         *utl-#idref*\r
                      References the defined `anchor' id=... in the target\r
                      document. See also |utl-fragmedtyp|. MyIdRef should be\r
                      an identifier (not a sequence of words). Note that\r
                      #r=foo and #r=foobar are distinguished whereas\r
                      #tn=foo will perhaps find the wrong position if there\r
                      also is as string foobar in the target document.\r
\r
\r
\r
1.2. Dependency of fragment interpretation from media type  *utl-fragmedtyp*\r
\r
According to RFC2396, the interpretation of fragments determined by\r
the type of the target document (see:\r
<URL:http://www.ietf.org/rfc/rfc2396.txt> #tn=is dependent on the media type )\r
\r
For media types other than "text/*" fragments will be ignored (e.g. for\r
"image/*")\r
\r
For "text/*" utl.vim makes a difference between "text/html" and all other\r
"text/*" subtypes.  But the interpretation of tn=, tp=, line= is the same for\r
_all_ text/* subtypes.  Just the IdRef interpretation is different:\r
\r
text/html   IdRef interpreted as a HTML-reference (i.e. NAME="myRef")\r
\r
text/*      IdRef interpreted as "txt-reference" (i.e. id=myRef)\r
\r
\r
\r
1.3 Utl.vim internals                                   *utl-internals*\r
\r
1.3.1 Definition of LocalPath\r
\r
Utl.vim internally has a notion "LocalPath".  LocalPath is an absolute path\r
of the local file system.  A real local file (or directory) with that name\r
exists. A pure buffer is not possible (at the moment). Utl's is simpler due\r
to this restriction.  For localPath a resource mapping exists.\r
\r
\r
1.4. Mappings and Commands                   *utl-mappings* *utl-commands*\r
\r
Note: The mappings below depend on the |mapleader| variable. This means,\r
instead of \gu it might be ,gu or whatever.\r
\r
1.4.1 `Goto URL under cursor' mappings                  *utl-gourlundercurs*\r
\r
The following mappings are available to execute the URL under the cursor:\r
\r
\ge, \gE, \gS, \gu                            *utl-ge* *utl-gS* *utl-gu*\r
        Goto URL under cursor. Open the target read/write.\r
        \ge replaces the current window with the target (:edit)\r
        \gE opens the target in a split window (:split).\r
        \gS opens the target in a vertical split window (:vsplit)\r
        \gu is the same as \ge. It is provided for easy mnemonics: gu = Go Url\r
            It's the only command you really have to know in order to use\r
            utl.vim!\r
\r
\gv, \gV                                                            *utl-gv*\r
        Goto URL under cursor. Open the target read only\r
        \gv replaces the current window with the target (:view).\r
        \gV opens the target in a split window (:sview).\r
\r
\gr                                                                 *utl-gr*\r
        Read the URL under cursor into the current buffer at the current\r
        position (:read)\r
\r
\r
1.4.2 `Goto visual URL' mappings                              *utl-gourlvis*\r
\r
Same as the above mappings, but the but the highlighted text is used as the\r
name of the URL. The visual mappings are useful when you have a text where the\r
URLs are not embedded. Example: "See http://vim.sf.net for useful Vim plugins"\r
\r
                                        *utl-v_ge* *utl-v_gs* *utl-v_gu*\r
{Visual}\ge, {Visual}\gE, {Visual}\gS {Visual}\gu\r
\r
{Visual}\gv, {Visual}\gV                                          *utl-v_gv*\r
\r
{Visual}\gr                                                       *utl-v_gr*\r
\r
\r
1.4.3. `Goto URL by command'                                  *utl-gourlcmd*\r
\r
Type in an URL manually.\r
\r
:Gu {URL}                                                          *utl-:gu*\r
        Goto the typed URL.\r
        The difference between \gu and :Gu is like in an web browser: typing\r
        an URL versus clicking an URL in the displayed text. But there is one\r
        important difference though. :Gu is executed in the context of the\r
        current buffer, i.e. :Gu myurl is the same as clicking \gu on\r
        <URL:myurl> in the text of the current buffer. That means that\r
        relative URLs are possible! So :Gu can be used for relative editing.\r
        See |utl-tipsguusage| or |utl-tuttypeurl| for examples of usage.\r
\r
\r
1.6.4. Other mappings and commands\r
\r
\gs                                                                 *utl-gs*\r
        Show the base URL that is associated with the current buffer in the\r
        status line, if any.\r
        Else shows the text `no associated URL'. That means, that the current\r
        buffer was not invoked as a link target (i.e. was not invoked through\r
        a utl.vim `Goto URL' command like \gu, :Gu etc).\r
        \gs just does a lookup utl's cache (see |utl-gc|).\r
\r
        Tip:\r
        If, in the `no associated URL' case, you like to know what the base\r
        URL is, you can first issue the command\r
            :exe ':Gu ' . expand('%')\r
        to "urlify" the current buffer (see |utl-tutfileisdef|); a\r
        subsequent \gs then shows the associated URL. This can be useful while\r
        learning utl.vim. The associated URL is always an absolute URL. And\r
        it is the base URL that would be taken when a link, containing a\r
        relative URL, would be executed out of the current buffer, e.g. a\r
        <URL:someUrl> is executed.\r
\r
\gc                                                                 *utl-gc*\r
        Shows utl.vim's internal cache map in a separate window.\r
        Useful mainly to see what's going on. See |utl-tutcachemap| for\r
        more information.\r
\r
\r
==============================================================================\r
2. Brief refresher on URL and URI                       *utl-uriprim*\r
\r
This chapter might be worth reading if you are thinking about designing your\r
own protocols. If you are going to extend Utl, it's source code will be easier\r
understandable if you know URLs better. But it is also intended for the\r
interested user to acquire a more thorough understanding of URLs and Utl in\r
general.\r
\r
Uniform Resource Identifiers are specified in RFC 2396, see <URL:http://www.\r
ietf.org/rfc/rfc2396.txt>.\r
\r
URI vs. URL                                             *utl-uri-uriurl*\r
-----------\r
#uu geht so nicht mehr!\r
( Reference: <URL:http://www.ietf.org/rfc/rfc2396.txt> #tn=^1.2.  )\r
\r
URL - Uniform Resource Locators are a subset of URI: A URL is a URI. As the\r
name says, a URL identifies a resource by its (network) location. Other ways\r
to identify a resource are suggested with "Uniform Resource Names" (URN).\r
URI = URL | URN.\r
\r
But for the purpose of utl.vim you can ignore the difference between URIs and\r
URLs.\r
\r
The three letters U, R, I                               *utl-uri-3letters*\r
-------------------------\r
( Reference: <URL:http://www.ietf.org/rfc/rfc2396.txt> #tn=^1.1 Overview \r
  The following material is directly taken from there )\r
\r
URI are characterized by the following definitions:\r
\r
Uniform\r
   Uniformity provides several benefits: it allows different types of resource\r
   identifiers to be used in the same context, even when the mechanisms used\r
   to access those resources may differ; it allows uniform semantic\r
   interpretation of common syntactic conventions across different types of\r
   resource identifiers; it allows introduction of new types of resource\r
   identifiers without interfering with the way that existing identifiers are\r
   used; and, it allows the identifiers to be reused in many different\r
   contexts, thus permitting new applications or protocols to leverage a\r
   pre-existing, large, and widely-used set of resource identifiers.\r
\r
Resource\r
   A resource can be anything that has identity.  Familiar examples include an\r
   electronic document, an image, a service (e.g., "today's weather report for\r
   Los Angeles"), and a collection of other resources.  Not all resources are\r
   network "retrievable"; e.g., human beings, corporations, and bound books in\r
   a library can also be considered resources.  The resource is the conceptual\r
   mapping to an entity or set of entities, not necessarily the entity which\r
   corresponds to that mapping at any particular instance in time.  Thus, a\r
   resource can remain constant even when its content---the entities to which\r
   it currently corresponds---changes over time, provided that the conceptual\r
   mapping is not changed in the process.\r
\r
Identifier\r
   An identifier is an object that can act as a reference to something that\r
   has identity.  In the case of URI, the object is a sequence of characters\r
   with a restricted syntax.\r
\r
Having identified a resource, a system may perform a variety of operations on\r
the resource, as might be characterized by such words as `access', `update',\r
`replace', or `find attributes'.\r
\r
\r
URI Syntactic Components                                *utl-uri-syntcomp*\r
------------------------\r
( Reference: <URL:http://www.ietf.org/rfc/rfc2396.txt> #tn=^3. URI Syntactic  )\r
\r
An URI goes like this:\r
\r
    <scheme>:<scheme-specific-part>\r
\r
That means, that the thing behind the colon is specific to the scheme!\r
The scheme-specific-part is also known as the `opaque' component.\r
But many schemes have a hierarchical structure, which is also defined by\r
RFC 2396. The syntax for hierarchical URI is:\r
\r
    <scheme>://<authority><path>?<query>\r
\r
The `authority' often is a host name (but can also be, say, a windows drive).\r
An example for a non hierarchical URI is the vimhelp scheme, e.g. `vimhelp:help'.\r
Another example is the mailto scheme: mailto:stb@bf-consulting.de\r
\r
Each of the above components may be missing, and it's still a valid URI.\r
\r
\r
URI References                                          *utl-uri-refs*\r
--------------\r
( Reference: <URL:http://www.ietf.org/rfc/rfc2396.txt> #tn=^4. URI References )\r
\r
    URI reference = URI # fragment\r
\r
The fragment is not part of an URI! But it often appears in conjunction with\r
it, so RFC2396 deals with the fragments also. Utl.vim doesn't care much\r
making the correct distinction. Most often it is clear from the context.\r
\r
\r
Fragment Identifiers                                    *utl-uri-fragids*\r
--------------------\r
( References: <URL:http://www.ietf.org/rfc/rfc2396.txt> #tn=^4.1. Fragment  )\r
\r
It is very important to realize, that fragment interpretation only depends on\r
the media type of the "retrieved" document. Not from, say, the scheme, i.e.\r
the protocol.\r
\r
This property is utilized by utl.vim since it defines fragment syntax for\r
generic, unstructured text (i.e. tn= line=).\r
\r
\r
Absolute and relative URI                               *utl-uri-relabs*\r
-------------------------\r
( Reference:\r
  <URL:http://www.ietf.org/rfc/rfc2396.txt> #tn=Relative URI references are distinguished  )\r
\r
URI come in two forms: relative and absolute. The rule to distinguish between\r
the two is very simple:\r
\r
    Scheme component exists = It's an absolute URI\r
\r
Normally, a relative URI is transformed into an absolute URI by the\r
application context in which the relative URI appears. Context = base URL\r
\r
\r
Escaping forbidden characters                           *utl-uri-forbchars*\r
-----------------------------\r
#uu stimmt nicht mehr so\r
( Reference: <URL:http://www.ietf.org/rfc/rfc2396.txt> #tn=^2. URI Char )\r
\r
Only a limited set of ascii characters are allowed in an URI.  Some other\r
characters, like < > ? / : for example, are reserved characters, in the sense\r
that they have a special meaning for the URI itself.\r
\r
If you need to use a forbidden or reserved character, you have to escape it\r
by its hex value. Examples:\r
\r
    `>'         -> `%3e'\r
    ` ' (blank) -> `%20'\r
\r
Hint: Just use Vim's :asc command <URL:vimhelp:asc> to find out the hex value of\r
a character!\r
\r
If in doubt if a character is forbidden you can also escape allowed\r
characters. Example: <URL:vimhelp:%61%73%63>\r
\r
\r
\r
==============================================================================\r
FOOTNOTES\r
\r
-----id=foot1\r
Thanks for trying out utl.vim :-)\r
\r
\r
 vim:tw=78:sw=4:sts=4:ts=8:ft=help:norl:\r