diff --git a/en/docproj/current.sgml b/en/docproj/current.sgml index 1087bb0d7e..d01ce834ae 100644 --- a/en/docproj/current.sgml +++ b/en/docproj/current.sgml @@ -1,239 +1,227 @@ - + %includes; ]> &header;

Here are the projects currently under way (or being actively contemplated on the freebsd-doc mailing list). I have also included some that have not really been talked about, but would probably be a good idea. Each project lists the contact person for that project (if I know who it is).

If you think you can contribute to any of these, please do not hesitate to stand up and be counted. You should talk to the person responsible for that particular project, who can then bring you up to speed on what is happening.

Any omissions in this list are entirely my fault (Nik Clayton, <nik@FreeBSD.ORG>), sorry in advance to anyone whose project I have missed.

Open documentation problem reports

Current FreeBSD problems reports are tracked using the GNATS database. You can view the open documentation problem reports.

FreeBSD for Linux users

Responsible: Annelise Anderson < andrsn@andrsn.stanford.edu>

Synopsis: Linux users coming to FreeBSD can be confused by some of the differences between the systems (the different default shells, how boot time configuration is performed, and so on). Annelise is coordinating the development of a tutorial/FAQ section that will address these points.

The list of current questions is at http://freebsd.stanford.edu/FreeBSD/linux.html.

- -

Fixup the FOO.TXT files

- -

Responsible: Doug - <studded@dal.net>

- -

Synopsis: The "FOO.TXT" files are the README files, the - INSTALL.TXTs. the ABOUT.TXTs and so on that you get with FreeBSD. Doug - (and others) are going through these trying to make sure they are - accurate, consistent, and easy to understand. A very worthwhile task.

-

Write a section in the Handbook and/or FAQ

Responsible: No one

Synopsis: Chunks of the FAQ and Handbook have empty sections in them. They need filling. If you have just had to use one of these documents to complete a task, and found them lacking, please find the time to write up your experiences as a possible replacement.

Alternatively, if you have just had to do something that had no entry in the FAQ and/or Handbook, please consider writing a new section. Then submit it as outlined above.

Write some new Papers

The New SCSI layer for FreeBSD (CAM)

Responsible: <doc@FreeBSD.org>, <scsi@FreeBSD.org>

Synopsis: See The Design and Implementation of the FreeBSD SCSI Subsystem for a first snapshot.

Write some new Tutorials

Responsible: <doc@FreeBSD.org>

Synopsis:

Write Manpages for the kernel

Responsible: <doc@FreeBSD.org>

Synopsis: Document kernel functions, section 9

CGI Scripts

Responsible: <doc@FreeBSD.org>, Wolfram Schneider <wosch@FreeBSD.org>

Synopsis:

Here are some hints how to write the ports module

A single line in /usr/ports/INDEX looks like

    xfig-3.2.2|/usr/ports/graphics/xfig|/usr/X11R6|A drawing program for X11|/usr/ports/graphics/xfig/pkg/DESCR|ports@FreeBSD.ORG|graphics x11|XFree86-3.3.2 Xaw3d-1.3 jpeg-6b xpm-3.4k|XFree86-3.3.2 Xaw3d-1.3 jpeg-6b netpbm-94.3.1 tiff-3.4 transfig-3.2 xpm-3.4k

The format is

    distribution-name|port-path|installation-prefix|comment| \
        description-file|maintainer|categories|build deps|run deps

The above INDEX line parsed into an anonymous hash object

 $port = {	
 	DISTRIBUTION_NAME   => 'xfig-3.2.2',
 	PORT_PATH           => '/usr/ports/graphics/xfig',
 	INSTALLATION_PREFIX => '/usr/X11R6',
 	COMMENT             => 'A drawing program for X11',
 	DESCRIPTION_FILE    => '/usr/ports/graphics/xfig/pkg/DESCR',
 	MAINTAINER          => 'ports@FreeBSD.ORG',
 	CATEGORIES          => ['graphics', 'x11'],
 	BUILD_DEPS          => ['XFree86-3.3.2', 'Xaw3d-1.3', 'jpeg-6b', 
 	                        'xpm-3.4k'],
 	RUN_DEPS            => ['XFree86-3.3.2',  'Xaw3d-1.3', 'jpeg-6b',
 				'netpbm-94.3.1', 'tiff-3.4', 'transfig-3.2',
 				'xpm-3.4k'] 
 };

Now we need some functions

Finally

Modify the cgi script url.cgi, ports.cgi , pds.cgi and the script portindex to use this module.

Contact Nik Clayton <nik@FreeBSD.ORG> for a first snapshot of the ports module.

Multilingual Web scripts

Responsible: <doc@FreeBSD.org>

Synopsis:

Our main Web pages are written in (American) English. The FreeBSD Translations Projects translate the web pages, Handbook and FAQ to other languages.

We must translate the cgi scripts and web build scripts too. The scripts should support multiple languages, not only one. Most scripts are written in perl.

Translations of the FreeBSD Documentation

Responsible: <doc@FreeBSD.org>

Translate the FreeBSD documentation (Web pages, FAQ, handbook, manpages) into other languages. See the FreeBSD translations projects

Search engine enhancements

Responsible: <doc@FreeBSD.org>

When searching the website, the output from the search engine includes the filename that was found, which might be something like FAQ34.html.

It would be more useful if the results included the question text, allowing the user to see whether or not the result was relevant.

FreeBSD Documentation Project Home &footer