bk2site.1

一百个病毒的源代码 包括熊猫烧香等 极其具有研究价值

removed.
.IP %NHCOMMENT 
the comment but with everything between < and > stripped out
that is, all the HTML stripped out (No HTML Comment). Also on 80 columns.
.IP %FSCOMMENT
the first sentence of the comment, that is, everything up to the
first period. A single letter with a period will be skipped. If there is
no period then the whole comment.
.IP %JSCOMMENT
the comment but with the appropiate characters escaped so that it can
be used as a JavaScript string.
.IP %JSFSCOMMENT
the first sentence of the comment, that is, everything up to the
first period. A single letter with a period will be skipped. If there is
no period then the whole comment. Special characters are escaped so that
the comment can be used as a JavaScript string.
.IP %DAYCRE
the day created
.IP %DAYVIS
the day last visited
.IP %DAYMODM
the day last Modified
.IP %MONTHCRE1
the month created, in number
.IP %MONTHCRE2
the month created, in English
.IP  %MONTHVIS1
the month visited, in number
.IP %MONTHVIS2
the month visited, in English
.IP %MONTHMOD1
the month modified, in number
.IP %MONTHMOD2
the month modified, in English
.IP %YEARCRE
last two digits of the year created
.IP %YEARFCRE
the year created, including all digits (the full number).
.IP %YEARVIS
last two digits of the year visited
.IP %YEARFVIS
the year visited, including all digits (the full number).
.IP %YEARFMOD
last two digits of the year modified
.IP %YEARMOD
the year modified, including all digits (the full number).
.IP %LEAFS
the total number of leafs under it (for folders only)
.IP %NEW
the new.gif, if the time is right.
.IP %TIMEFCRE
the time created in full Wed Jun 30 21:49:03 1993
.IP %TIMEFMOD
the time modified in full Wed Jun 30 21:49:03 1993
.IP %TIMEFVIS
the time visited in full Wed Jun 30 21:49:03 1993
.IP %CONDDASH
prints a dash "-" if the comment is not null
.IP %IFCOMHAS(string)(html)
if the comment has "string" then insert "html" at point.
also eliminate "string" from comment.
e.g. %IFCOMHAS(*coolsite*)(<img src="/images/cool.gif">)   or
%IFCOMHAS(-neat-)(<font color="red">Neat Site</font>)
If you use it, you must use it for ALL templates
.IP %HITS
the number of hits this url has receives, as gathered from urllogfile
.PP
There are also functions you can use. Right now, these functions
are NOT available for search.pl so you should not use them in
your searchurltemplate variable in your .bk2siterc. 

Each function takes one or more arguments and gets replaced by the
results of applying that function to the given arguments. The function are:

.IP &FILL[arg|cols]
where arg is a string and cols is an integer. This function auto-fills
the given argument to cols columns. e.g. &FILL[%COMMENT].
.IP &NOHTML[arg]
where arg is a string. Gets rid of all the HTML in the argument. That is,
everything between < and >.
.IP &REPLACE[arg|from|to]
where arg, from, and to are strings. It replaces all instances of 
"from" with "to" in "arg".
.IP &CUT[arg|chars]
where arg is a string and chars is an integer. It returns the first
"chars" characters in "arg".
.IP &NOLINEBREAKS[arg]
where arg is a string. It replaces all newlines, returns and tabs
with spaces, in arg.
.IP &NOACCENTS[arg]
where arg is a string. It replaces all accented characters with their
non-accented counterparts. It also gets rid of other troublesome
characters.
.IP &FS[arg]
where arg is a string. It returns the first sentence in arg.
.PP

These functions can be nested, as in &CUT[&NOHTML[%COMMENT]|500]. The
strings used as arguments to these functions cannot include the characters
[, ], or | since that will confuse the parser.

.SH Netscape Navigator Comments
As you know, navigator allows you to give comments to bookmars and
folders. We use these to guide the behavior of bk2site (see below and
read dot.bk2siterc, esp %IFCOMHAS) and we also print them.

You can also use HTML in the comment and it will work, but:

*********WARNING********************WARNING***********

DO NOT PUT "HREF=" IN YOUR COMMENT. There is a bug in Navigator that
will make it mungle your bookmarks if you do that. The bug has been
reported. 

If you must, use "HREF =". The space is VERY important. I actually
like to use "href =". The use of lowercase and a space makes me feel
doubly safe.

*********WARNING********************WARNING***********

.SH Using Aliases
bk2site supports url aliases, as used by navigator. 

It also implements directory aliases. Since Navigator does not allow
us to create an alias for a folder/directory, we must do it with a
little hack.

Say you have a folder called "people" and you want to put an alias to
it somewhere else. You should go to where you want the alias to appear 
and create an empty folder called "people", then add the comment ALIAS
in the comment box for that folder.

That's it, the empty folder "people" will now appear with an @ at the
end of it (in the website) and will point to the real "people"
folder. You can have as many ALIAS folders as you want, pointing to
the same or different folders.

There's also support for directory aliases where the ALIAS name is
different from the real folder. So if you have a folder called
"robots" as a subfolder of your "Business" folder and you want to put an
alias to it called "Commercial" into your "AI" / "robotics" folder,
go to "robotics", create an empty folder called "Commercial", and finally
add the comment "ALIAS robots" in the comment box for that folder.

.SH Setting Private Folders
If there is a particular entry or folder that you want bk2site to
ignore simply give it the comment PRIVATE. The comment must be all
in capital letters and must be the only text on the comment field.

.SH Sorting Bookmarks
You can also have bk2site automatically sort the bookmarks in a
folder. This is done by adding the appropiate comments to the
folder. The valid values are:

.IP "sort title normal"
sorts based on title, alphabetically.
.IP "sort title inverse"
in inverse alphabetical on title.
.IP "sort creation normal"
Sort based on the time when the bookmark was
created. The more recent ones come first.
.IP "sort creation inverse"
more recent come last.
.IP "sort modified normal"
Sort based on the time when the bookmark was
last modified. The more recent ones come
first.
.IP "sort modified inverse"
more recent come last.
.IP "sort visit normal"
Sort based on the time when the bookmark was
last visited. The more recent ones come
first.
.IP "sort visit inverse"
more recent come last.
.IP "sort hits normal"
Sort based on the number of hits, as determined
by reading the urllog file. The ones with more hits
come first
.IP "sort hits inverse"
Less hits come first.
.PP

These comments are case-insensitive.

Remember that the folders only have a title and a creation date, so
sorting them on visit or modified will not do anything to them.

.SH Output of Bookmark file

You can use the -o switch, or the "outputbookmarkfile" variable in
.bk2siterc, to tell bk2site to output a bookmark file that contains
only the bookmarks that are shown on the website. That is, it excludes
those that were not under the main folder and those that where under
PRIVATE folders. For example
.EX
bk2site -o /tmp/published-bookmarks.html
.EE
will write out to /tmp/published-bookmarks.html. This is useful if you
want to give someone else a bookmark file containing only your public
bookmarks. Netscape can read these bookmark files.

The -ns switch prevents bk2site from actually generating a website. It
is useful when you just want to generate the output bookmarkfile
without creating a website:
.EX
bk2site -ns -o /tmp/published-bookmarks.html 
  bookmarkfile1.html file2.html file3.html
.EE
There are a couple of problems with this output. bk2site will (1) Ignore
any <HR> in the original. (2) Replace all <BR> with a space (they are
there, trust me).  (3) Get rid of "sort" comments, instead the
bookmarks will be sorted with the appropiate order.

.SH Merging Bookmark Files

bk2site can merge several bookmark files. For example:
.EX
bk2siste -o /tmp/merged-bookmarks.html 
  ~/.netscape/bookmarks.html /home/joe/.netscape/bookmarks.html
.EE
will merge your bookmarks (~/.netscape/bookmarks.html)
with  Joe's (/home/joe/.netscape/bookmarks.html)

In order for this to happen, Joe's bookmarks must have some folders
with the comment PUBLISH on them. Each one of these folders will be
matched (using its name) with a folder on your bookmark file. The two
folders, along with any subfolders, will be merged. If Joe has extra
subfolders, they will be created and added.

If a new bookmark has the same (identical) URL as one already in that
folder, it will be ignored.

The new bookmarks are added at the end of the folder. If you want to
change the order, use the sort commands above.

This technique works fine if you and Joe are coordinating---Joe must
place the PUBLISH comments in the appropiate folders. But, what if you
downloaded a bookmarks.html file from the web and want to add it, as
is, to your site. This can be accomplished with the INCLUDE keyword.

You simply create a folder where you want to include the new
bookmarfile, and give it the comment:
.EX
INCLUDE /tmp/filename.html
.EE
or you can use a url like
.EX
INCLUDE http://www.multiagent.com/multiagent-bookmarks.html
.EE
The file will be read and merged under that folder. Since they are
merged, you can also add your own bookmarks under the folder.

To summarize: Merging can be done either by:

1- Specifying many files on the command line. The first one is the
root bookmark file, the rest of them must have folders marked
"PUBLISH", which will be merged with the folders on the root bookmark
file with the same name.

2- Including the comment "INCLUDE url" in some of your folders,
where url is the name of some other bookmark file to include
under that folder. You can also add your own bookmarks under this
folder.

.SH Generating extra files.
If you want to generate more files, for example, a file just the
tophits or just the new additions, this can be done using the
"extrafilebase" and "extrafilename" variables in your .bk2siterc. 

.IP "extrafilebase"
The base file for an extra file you wish to generate.
.IP "extrafilename" 
The name of the output file.
.PP

These two variables need to appear in pairs and in order, for example: 
.EX
extrafilebase	/etc/bk2site/newbase.html
extrafilename	new.html
.EE
This means that the base file is newbase.html and the output file
generated by processing this base file will be written to
new.html. Note that the files you create need not be html. In fact,
this feature can be used to generate any kind of text file
(e.g. my.netscape channels, email newsletters, etc.). 

.SH Displaying channels

[For the uninitated, channels are simply xml files that summarize a
site's contents. Many popular news sites like slashdot and freshmeat
make these available for anyone to download and use, as long as you
give them proper credit. Please read and obey each individual site's
use restrictions for their content.]

Another fun feature is to read and display other people's my.netscape
channels in your pages. This can be done by first setting three
variables in your .bk2siterc for each channel that you whish to
show. The variables are.

.IP "channelname"
The name you will use to refer to this channel. Pick something you can 
remember.
.IP "channelurl"
The url where we can download this channel. bk2site only supports
http: and file: methods. ftp will have to wait.
.IP "channelfile"
A file to which we write the channel we just read. Also, if the
channel cannot be downloaded from the url, bk2site will read this file 
instead. This way you avoid having empty channels in your pages.
.PP

For example, to set up a slashdot channel you would do:
.EX
channelname slashdot
channelurl http://slashdot.org/slashdot.rdf
channelfile /tmp/slashdot-channel
.EE

Now, this sets up the channel but it does not display it. In order to
display the channel you must define a section like the ones we used
before but using the channel name instead of a section name. For
example, to display the slashdot channel you would place the following
in one (or more) of your base files:
.EX
<!--bk2site:begin slashdot-->