Missing help page: Syslog module

Here is a first crack at this. There was actually a large description on the administration page help text so I moved the meat of that to the help page and pointed the admin help text to that for more info. This keeps the admin page simpler and to the point. I also changed "system administration" to "operating system administration" in all locations because many people that are not familiar with sysadmin may not be clear that this is something on their OS and not their Drupal "system."

One bit that I find confusing is that the "PHP's syslog" link is pointing to the openlog entry and not syslog's. This is disconcerting so maybe we should explain that. Since I'm not sure why that is the way it is though I'm not making an attempt to explain it, so I'm setting this to CNW. ;-)

There seems to be too much stuff to "see" :)

"For more information on syslog facilities, severity levels, and how to setup a syslog.conf file, see UNIX/Linux see"

Also the help text now only seem to explain UNIX/Linux stuff while no Windows setup is explained (although the config form seem to have information on Windows). From the PHP docs: "On Windows NT, the syslog service is emulated using the Event Log." (I would say this is for NT or newer versions).

Also http://drupal.org/handbook/modules/syslog/ seems to be a buggy link. Why have the slash at the end?

About the php documentation link, openlog() seems to offer more information about options and facilities while the syslog() docs page details severity levels.

There is no Drupal handbook page for Syslog.module at the moment - should the link just be removed?

Hm, well no. All core modules also need a handbook page so I dare say that the page should be created and the basic text we settle on here can be used as the initial text there.

I see no point in linking to "more information" on drupal.org when it is in fact the same information. What new content is needed separately on drupal.org?

The drupal.org page can have comments and can evolve from time to time with more setup tips and so on. The help text in Drupal will keep being the same.

Here's a basic re-roll: fixed "see" typo and removed the terminating slash from the URL.

I made a place-holder handbook page at http://drupal.org/node/185753 but I don't have permissions to set the URL alias.

I added the handbook/modules/syslog alias to that page.

Reviewed again:

- The help text still only seem to explain UNIX/Linux stuff while no Windows setup is explained (although the config form seem to have information on Windows). From the PHP docs: "On Windows NT, the syslog service is emulated using the Event Log." (I would say this is for NT or newer versions).
- "facility" is used twice in the first paragraph, the first could easily be "Enables Drupal to log messages..."
- The "For more information" text does not use the standard text used elsewhere in core modules.
- I am not sure the admin/settings/logging/syslog entry needs such a long description. Other modules don't have this long text on the admin page.

Let's get this done!

- Included Windows info. I don't think we need to say NT or newer. It's 2007.
- Reworded first paragraph. Incorporated cleanup from duplicate issue.
- The standard text used elsewhere in core modules erroneously refers to a "configuration and customization handbook" that doesn't seem to exist; core module help is under Getting Started - Core modules.

This patch builds off the one in #10, but makes further edits in the hopes of cleaning up some of the "facilities user" stuff.

I think the "code" references are still a bit confusing, but it's definitely an improvement.

"Identifier" maybe?

Testing:

It applies cleanly.
It does what it's intended to do.

I think "syslog facility" is quite heavily used in the latest patch, when appropriate, so it should be fine for some googling, and looks like proper term usage to me. webchick, you agree with this and you just commented on some suggestions, or not? If agreed, this might be RTBC.

syslog facility seems fine to me, code/identifier would be less good. The rest of the help text looks good, explains it well and points to further information rather than trying to do too much, so I think it's RTBC and would interpret webchick's comments as such.

Great, committed, thanks.