Bug 14165

Summary: FDP introduction article
Product: Documentation Reporter: nbm <nbm>
Component: Books & ArticlesAssignee: nbm
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.shar none

Description nbm 1999-10-06 15:50:01 UTC 
This provides an index of the (English) documentation provided by
the FreeBSD Documentation Project.  It installs as
/usr/share/doc/index.en_US.ISO_8859-1.html, and index.html is
symlinked to it, if English is the primary language.

This could be used as an index for a web server whose root is
/usr/share/doc (which is what I have).
Comment 1 nik freebsd_committer freebsd_triage 1999-10-26 21:51:25 UTC 
On Wed, Oct 06, 1999 at 02:24:29PM -0000, nbm@rucus.ru.ac.za wrote:
> >Synopsis:       FDP introduction article

<...>

> >Description:
> 
> This provides an index of the (English) documentation provided by
> the FreeBSD Documentation Project.  It installs as
> /usr/share/doc/index.en_US.ISO_8859-1.html, and index.html is
> symlinked to it, if English is the primary language.

<ponder>

Assuming for the moment that the effort underway to automatically generate
a hyperlinked list of pointers to documentation about ports/packages 
available on the local machine succeeds (I hope it does), and further 
assuming that this effort will need to read files in /var/db/pkg (COMMENT 
and DESCR, to name two) in order to build this list, and knowing that the 
documentation is now pkg_add'able. . .

. . . would we not be better off massaging the package target to
automatically pull out the title and/or <abstract> from each document, as
text for COMMENT and DESCR files (assuming they didn't already exist).

"make install" could be tweaked to do the install, and then put the 
necessary files in /var/db/pkg (I'm somewhat hazy about how the ports
system does this).

The docs would then automatically appear on this automatically generated
list of links to documentation.  The list would also be up to date with
respect to the documentation the user had actually installed.

Thoughts?

N
Comment 2 Jeroen Ruigrok van der Werven freebsd_committer freebsd_triage 1999-12-22 15:53:44 UTC 
Responsible Changed
From-To: freebsd-doc->nbm

Let Neil use his commit bit to close his own PR's. =)
Comment 3 nbm freebsd_committer freebsd_triage 2003-08-13 11:02:56 UTC 
State Changed
From-To: open->closed

No use having this relic of mine hang about.