Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 07 Sep 2000 01:26:02 +0100 (BST)
From:      Andrew Boothman <andrew@cream.org>
To:        Mark Ovens <marko@freebsd.org>
Cc:        Andrew Boothman <andrew@dogma.freebsd-uk.eu.org>, doc@freebsd.org
Subject:   RE: Ports Documentation Index - the next installment
Message-ID:  <XFMail.000907012602.andrew@cream.org>
In-Reply-To: <20000906002540.M254@parish>

next in thread | previous in thread | raw e-mail | index | archive | help
This message is in MIME format
--_=XFMail.1.3.p0.FreeBSD:000907012602:569=_
Content-Type: text/plain; charset=us-ascii


On 05-Sep-00 Mark Ovens wrote:
> The changes I've made are:
> 
>     1. Improved the weeding out of non-doc files (it uses the
>        +CONTENTS file).

Cool. The more intelligence we can fit into that script the better.

>     2. The HTML file now has the ports sorted alphabetically.

I would have got around to that. Honest. :-)

>     3. The HTML file now has an index of all the installed
>        ports (that have docs) at the top with the port name as a link
>        (followed by the contents of the +COMMENT file) to the list of
>        docs, which have a link back to the top.

Yup. That's easier and quicker to read then the way my script was generating
the file.

>     4. The filename is displayed instead of "Title Unknown" for
>        non-HTML files (although HTML files that have no
>        <title></title> tag are still listed as "Title Unknown").

Ah Ha! The latest version of mine was already doing that! :-)

> I've attached 3 files:

All great stuff. I've no complaints. The only difference between the output of
your script and mine is a few cosmetic things suggested by Nik a while back,
like a title image and some statistics at the bottom of the output. Trivial
stuff.

Attached is the latest version of the script which I had. But I think work
should continue on yours now.

> CAVEATS:
>       It may or may not included the standard FreeBSD docs
>       (Handbook, FAQ, etc.) in the HTML file depending on where they
>       are installed on your system.

Plus it only links to the english version of the docs. I guess we should really
handle all the languages.
 
>       I'm just a beginner at perl, so not too many flames about the
>       code, eh? (Hot Tips and friendly advice accepted :))

Ha! I think you made a better job of it then I did! You were starting with a
pretty scrappy script to start with.

>       There are still some debugging print() statements that
>       spew out a lot of stuff to STDOUT when docsmaker runs.

Yeah. Like I started saying, I never really intended what I was doing to be the
basis of anything offical, I just picked up an idea of Nik's and started
playing with it. A flood of use[less|ful] print statements tend to be a
hallmark of me playing with ideas. I like to see what a program is doing until
I've got some confidence in it. :-)

I think this whole index thing was mentioned on the list a few months or so
back, I tried to e-mail you all but Cable Internet (my ISP) appeared to not be
passing on e-mails at the time. I don't know what happened to my email. And I
never got around to re-sending it.

Anyway, sorry to Mark for not getting in touch sooner.

---
Andrew Boothman <andrew@cream.org>
http://sour.cream.org

--_=XFMail.1.3.p0.FreeBSD:000907012602:569=_
Content-Disposition: attachment; filename="docindex"
Content-Transfer-Encoding: base64
Content-Description: docindex
Content-Type: application/octet-stream; name=docindex; SizeOnDisk=2922

IyEvdXNyL2Jpbi9wZXJsCgojIFByb2R1Y2VzIGFuIEhUTUwgbGlzdCBvZiBkb2N1bWVudGF0aW9u
IGluc3RhbGxlZCBieQojIHRoZSBGcmVlQlNEIHBvcnRzIHN5c3RlbSBvciBieSB0aGUgbG9jYWwg
c3lzYWRtaW4uCiMgSW50ZW5kZWQgdG8gYmUgcnVuIGRhaWx5IGZyb20gL2V0Yy9wZXJpb2RpYy9k
YWlseSAKIyBvciBvbiBzdGFydHVwIGJ5IC9ldGMvcmMKCiMgU2VlIGh0dHA6Ly91a3VnLnVrLkZy
ZWVCU0Qub3JnL35hbmRyZXcvZG9jaW5kZXgvCgojIEJ5IEFuZHJldyBCb290aG1hbiA8YW5kcmV3
QHVrdWcudWsuRnJlZUJTRC5vcmc+CgojIElmIGFueSBkb2N1bWVudGF0aW9uIGhhcyBiZWVuIGFs
dGVyZWQgc2luY2Ugd2UgbGFzdCBtYWRlIHRoZSBpbmRleAojIHRoZW4gYnVpbGQgaXQgYWdhaW4s
IGVsc2UgZG9uJ3QgYm90aGVyCgppZiAoLU0gJy92YXIvZGIvcGtnJyA8IC1NICcvdXNyL2xvY2Fs
L3NoYXJlL2RvYy9pbnN0ZG9jcy5odG1sJyB8fCAtTSAnL2V0Yy9kb2NzLmxvY2FsJyA8IC1NICcv
dXNyL2xvY2FsL3NoYXJlL2RvYy9pbnN0ZG9jcy5odG1sJykgewoJJGxvY2FsdGltZSA9IGxvY2Fs
dGltZTsKCSR0aW1lID0gdGltZTsKCSRub29mZG9jcyA9IDA7CglvcGVuICdpbmRleGZpbGUnLCc+
L3Vzci9sb2NhbC9zaGFyZS9kb2MvaW5zdGRvY3MuaHRtbCc7CglvcGVuZGlyICdwb3J0c2Rpcics
ICcvdmFyL2RiL3BrZycgb3IgZGllICJkb2NpbmRleDogQ2FuJ3Qgb3BlbiAvdmFyL2RiL3BrZyI7
CgoJQGFsbGZpbGVzID0gcmVhZGRpciAncG9ydHNkaXInOwoKCWNsb3NlZGlyICdwb3J0c2Rpcic7
CgkKCWlmICgtZCAnL2V0Yy9kb2NzLmxvY2FsJykgewoJCW9wZW5kaXIgJ2xvY2FsZG9jc2Rpcics
Jy9ldGMvZG9jcy5sb2NhbCcgb3IgZGllICIvZXRjL2RvY3MubG9jYWwvIGV4aXN0cyBidXQgY2Fu
J3QgYmUgb3BlbmVkIjsKCQkKCQlAYWxsZmlsZXMgPSAoQGFsbGZpbGVzLHJlYWRkaXIoJ2xvY2Fs
ZG9jc2RpcicpKTsKCQkKCQljbG9zZWRpciAnbG9jYWxkb2NzZGlyJzsKCX07CgoJQGFsbGZpbGVz
ID0gc29ydChAYWxsZmlsZXMpOwoKCXByaW50IGluZGV4ZmlsZSAnPEhUTUw+CjxIRUFEPgo8VElU
TEU+SW5zdGFsbGVkIERvY3VtZW50YXRpb248L1RJVExFPgo8L0hFQUQ+CjxCT0RZIEJHQ09MT1I9
IiNGRkZGRkYiPgo8ISAtLSBUaGlzIHBhZ2UgaXMgYXV0b21hdGljYWxseSBnZW5lcmF0ZWQuIERP
IE5PVCBlZGl0IGJ5IGhhbmQhISAtLT4KPCEgLS0gUGxlYXNlIHNlZSAvdXNyL3NoYXJlL2RvYy9k
b2NzaW5kZXgvIGZvciBtb3JlIGluZm8gLS0+CjxJTUcgU1JDPSIvdXNyL3NoYXJlL2RvYy9kb2Nz
aW5kZXgvZnJlZWJzZF90aXRsZS5naWYiIEFMSUdOPSJSSUdIVCI+CjxIMj5JbnN0YWxsZWQgRG9j
dW1lbnRhdGlvbjwvSDI+JzsKCXByaW50IGluZGV4ZmlsZSAiPEk+TGFzdCBVcGRhdGVkIDogJGxv
Y2FsdGltZTwvST4iOwoJcHJpbnQgaW5kZXhmaWxlICc8SFI+PFVMPic7CgkJCQkKCWZvcmVhY2go
QGFsbGZpbGVzKXsKCQkjIENoZWNrIGlmIGVhY2ggb2YgdGhlIGZpbGVzIHdlJ3ZlIGZvdW5kIGlz
IGEgZGlyZWN0b3J5CgkJIyB3aXRoIHRoZSArRE9DUyBmaWxlIGluIGl0CgkJaWYgKC1lICIvdmFy
L2RiL3BrZy8kXy8rRE9DUyIpIHsKCQkJb3BlbiAnRE9DUycsIi92YXIvZGIvcGtnLyRfLytET0NT
IiBvciBkaWUgIi92YXIvZGIvcGtnLyRfLytET0NTIGV4aXN0cyBidXQgY2FuJ3QgYmUgb3BlbmVk
IjsKCQkJJkRvY3NGaWxlSGFuZGxlcjsKCQl9IGVsc2lmICgtZiAiL2V0Yy9kb2NzLmxvY2FsLyRf
IikgewoJCQlvcGVuICdET0NTJywiL2V0Yy9kb2NzLmxvY2FsLyRfIiBvciBkaWUgIi9ldGMvZG9j
cy5sb2NhbC8kXyBleGlzdHMgYnV0IGNhbid0IGJlIG9wZW5lZCI7CgkJCSZEb2NzRmlsZUhhbmRs
ZXI7CgkJfTsKCQkJc3ViIERvY3NGaWxlSGFuZGxlciB7CgkJCUBkb2NzID0gPERPQ1M+OwoJCQlj
bG9zZSAnRE9DUyc7CgkJCWNob21wIEBkb2NzOwoJCQlwcmludCBpbmRleGZpbGUgIjxBIE5BTUU9
XCIkX1wiPjwvQT48TEk+JF8gPFVMPlxuIjsKCQkJIyBQcmludCBvdXQgYSBsaW5rIGZvciBlYWNo
IGl0ZW0gb2YgZG9jdW1lbnRhdGlvbgoJCQkjIGluIHRoZSBmaWxlCgkJCWZvcmVhY2goQGRvY3Mp
IHsKCQkJCSRub29mZG9jcysrOwoJCQkJQGRvY2luZm8gPSBzcGxpdCgvOi8pOwoJCQkJcHJpbnQg
aW5kZXhmaWxlICI8TEk+JGRvY2luZm9bMF0gLSBbPEEgSFJFRj1cIiRkb2NpbmZvWzJdXCI+JGRv
Y2luZm9bMV08L0E+XVxuIjsKCQkJfTsKCQkJcHJpbnQgaW5kZXhmaWxlICI8L1VMPlxuIgoJCQl9
OwkJCgkJfTsKcHJpbnQgaW5kZXhmaWxlICc8L1VMPjxIUj4KPEg0PkxpbmtzPC9IND4KPFVMPgo8
TEk+PEEgSFJFRj0iL3Vzci9zaGFyZS9kb2MvZG9jc2luZGV4L1JFQURNRSI+TW9yZSBJbmZvcm1h
dGlvbiBvbiB0aGUgaW5kZXg8L0E+CjxMST48QSBIUkVGPSJodHRwOi8vd3d3LmZyZWVic2Qub3Jn
L2NnaS1iaW4vcG9ydHMuY2dpIj5SZWNlbnRseSBDaGFuZ2VkIFBvcnRzPC9BPgo8L1VMPgo8SFI+
PEk+JzsKJHRpbWV0YWtlbiA9IHRpbWUgLSAkdGltZTsKaWYgKCR0aW1ldGFrZW4gPT0gMCkgewoJ
cHJpbnQgaW5kZXhmaWxlICdUaW1lIFRha2VuIDogPDEgc2Vjb25kPEJSPic7Cn0gZWxzaWYgKCR0
aW1ldGFrZW4gPT0gMSkgewoJcHJpbnQgaW5kZXhmaWxlICdUaW1lIFRha2VuIDogMSBzZWNvbmQ8
QlI+JzsKfSBlbHNlIHsKCXByaW50IGluZGV4ZmlsZSAiVGltZSBUYWtlbiA6ICR0aW1ldGFrZW4g
c2Vjb25kczxCUj4iOwp9OwpwcmludCBpbmRleGZpbGUgIkFwcGxpY2F0aW9ucyBXaXRoIERvY3Vt
ZW50YXRpb24gOiAkI2RvY3M8QlI+IjsKcHJpbnQgaW5kZXhmaWxlICJJdGVtcyBPZiBEb2N1bWVu
dGF0aW9uIEluc3RhbGxlZCA6ICRub29mZG9jcyI7CnByaW50IGluZGV4ZmlsZSAnPC9JPjwvQk9E
WT48L0hUTUw+JzsKfTsK

--_=XFMail.1.3.p0.FreeBSD:000907012602:569=_--
End of MIME message


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?XFMail.000907012602.andrew>