You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-dev@perl.apache.org by Per Einar Ellefsen <pe...@skynet.be> on 2002/04/26 22:27:15 UTC
[PATCH] tips/
Hello,
I changed some things in Bill's (otherwise excellent) tips section. The
main point was to change the configuration style to the one most widely
used in Apache/mod_perl docs, and to fix broken links.
I also noticed that many files need to be removed from the repository (in
src/):
- stories/.cvsignore
- the support/ dir
- start/about.html
- start/tips/*.html
- start/tips/logging.pod, if it's not going to be used (although it is
pretty cool).
- about/ and about/tips directories
- download/distributions.html
That's all I could find for now.
Index: src/start/tips/registry.pod
===================================================================
RCS file: /home/cvspublic/modperl-docs/src/start/tips/registry.pod,v
retrieving revision 1.2
diff -u -u -r1.2 registry.pod
--- src/start/tips/registry.pod 26 Apr 2002 01:43:11 -0000 1.2
+++ src/start/tips/registry.pod 26 Apr 2002 20:24:41 -0000
@@ -24,11 +24,11 @@
This script can now be run as-is under C<Apache::Registry> by using the
following configuration in I<httpd.conf>:
- <files hello.cgi>
+ <Files hello.cgi>
SetHandler perl-script
PerlHandler Apache::Registry
Options ExecCGI
- </files>
+ </Files>
That's basically it. Your scripts do need to be well coded, but
there's even the C<Apache::PerlRun> module to help with those "less
@@ -44,7 +44,7 @@
Apache version 1.3.20</small>
For more information on running CGI scripts under mod_perl please see
-L<mod_perl FAQs|"../../docs/1.0/faqs/index.html">.
+L<mod_perl FAQs|docs::1.0::faqs::index>.
=for html
<a class="more" href="../index.html#registry">« back</a>
Index: src/start/tips/handler.pod
===================================================================
RCS file: /home/cvspublic/modperl-docs/src/start/tips/handler.pod,v
retrieving revision 1.6
diff -u -u -r1.6 handler.pod
--- src/start/tips/handler.pod 26 Apr 2002 05:43:59 -0000 1.6
+++ src/start/tips/handler.pod 26 Apr 2002 20:24:41 -0000
@@ -38,17 +38,17 @@
Save the above as a file file in your perl library
-(e.g. I<My/Greeting.pm>a). Now, to return the above greeting when the
+(e.g. I<My/Greeting.pm>). Now, to return the above greeting when the
URL I</hello> is visited on your server:
- <location /hello>
+ <Location /hello>
SetHandler perl-script
PerlHandler My::Greeting
- </location>
+ </Location>
For a more in-depth explanation of creating mod_perl handlers see
-L<Documentation|"../../docs/index.html">. The L<mod_perl
-Guide|"../../docs/1.0/guide/index.html"> is also recommended reading.
+L<Documentation|docs::index>. The L<mod_perl Guide|guide::index> is
+also recommended reading.
=for html
<a class="more" href="../index.html#handler">« back</a>
Index: src/start/tips/logging.pod
===================================================================
RCS file: /home/cvspublic/modperl-docs/src/start/tips/logging.pod,v
retrieving revision 1.3
diff -u -u -r1.3 logging.pod
--- src/start/tips/logging.pod 26 Apr 2002 01:49:53 -0000 1.3
+++ src/start/tips/logging.pod 26 Apr 2002 20:24:41 -0000
@@ -8,10 +8,10 @@
example of a C<PerlLogHandler>. The C<PerlLogHandler> is one of the
last phases of the request cycle.
-This example sends mail when a request is made to the /private section
-of your web space. A more common use of a C<PerlLogHandler> might be
-to track hits on a specific set of URLs, or to write logging data to a
-relational database.
+This example sends mail when a request is made to the I</private>
+section of your web space. A more common use of a C<PerlLogHandler>
+might be to track hits on a specific set of URLs, or to write logging
+data to a relational database.
file:My/Notify.pm
------------------------
@@ -41,10 +41,10 @@
The I<httpd.conf> setup:
- <location /private>
+ <Location /private>
SetHandler perl-script
PerlLogHandler My::Notify
- </location>
+ </Location>
=for html
<a class="more" href="../index.html#logging">« back</a>
Index: src/start/tips/favicon.pod
===================================================================
RCS file: /home/cvspublic/modperl-docs/src/start/tips/favicon.pod,v
retrieving revision 1.2
diff -u -u -r1.2 favicon.pod
--- src/start/tips/favicon.pod 26 Apr 2002 01:43:11 -0000 1.2
+++ src/start/tips/favicon.pod 26 Apr 2002 20:24:41 -0000
@@ -9,8 +9,8 @@
I<favicon.ico> and rewrites the request to point to a vaild location.
No more logs full of 404 errors.
-This example is adapted from the L<mod_perl Devekioer's
-Cookbook|http://modperlcookbook.com>, chapter 12.
+This example is adapted from the mod_perl Developer's Cookbook
+(http://modperlcookbook.com), chapter 12.
file:Cookbook/Favicon.pm
------------------------
@@ -35,7 +35,7 @@
PerlTransHandler Cookbook::Favicon
Although this example could easily be accomplished with Apache's
-mod_rewrite module, this example demonstrates how easy it is to
+C<mod_rewrite> module, this example demonstrates how easy it is to
rewrite URLs programatically, using the power of Perl.
=for html
--
Per Einar Ellefsen
per.einar@skynet.be
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: [PATCH] tips/
Posted by Per Einar Ellefsen <pe...@skynet.be>.
At 04:56 27.04.2002, Stas Bekman wrote:
>Per Einar Ellefsen wrote:
>
>>I also noticed that many files need to be removed from the repository (in
>>src/):
>
>
>How do you update your cvs rep? do you supply -dP or do you have it in
>your .cvsrc? Mine is:
>~/.cvsrc:
>cvs -z9
>update -dP
>diff -u
>
>with these flags empty dirs get pruned automatically.
Yes, that's what I have. It just doesn't work. Hmm, i'll try removing the
dir from my Entries file, and then remove it manually. Nope, didn't work, I
still keep getting it back. Has it been deleted from the repository?
stories/ still contains .cvsignore though, so that won't disappear.
--
Per Einar Ellefsen
per.einar@skynet.be
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: [PATCH] tips/
Posted by Stas Bekman <st...@stason.org>.
Per Einar Ellefsen wrote:
> I also noticed that many files need to be removed from the repository
> (in src/):
How do you update your cvs rep? do you supply -dP or do you have it in
your .cvsrc? Mine is:
~/.cvsrc:
cvs -z9
update -dP
diff -u
with these flags empty dirs get pruned automatically.
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: [PATCH] tips/
Posted by Per Einar Ellefsen <pe...@skynet.be>.
At 00:48 27.04.2002, Bill Moseley wrote:
>At 10:27 PM 04/26/02 +0200, Per Einar Ellefsen wrote:
> >I changed some things in Bill's (otherwise excellent) tips section. The
> >main point was to change the configuration style to the one most widely
> >used in Apache/mod_perl docs, and to fix broken links.
>
>Sorry for the collision. I just checked in what changes I made earlier
>today, and tried to incorporate everything you suggested, too.
>
>I'm still not thrilled with the writing. Too much use of the word "power",
>for one thing. So any suggestions would be great.
>
>I don't think it's emphasized enough that mod_perl really can make
>maintaining code easy, and development is fast.
>
>Also, on purpose I didn't name specific CPAN modules one might use (e.g.
>LDAP) as it's just too huge. But on the other hand, it sometimes doesn't
>hurt to throw around buzzwords. Again, I'm open to suggestions. Please.
Ok, I'll take a look sometime.
--
Per Einar Ellefsen
per.einar@skynet.be
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: [PATCH] tips/
Posted by Bill Moseley <mo...@hank.org>.
At 10:27 PM 04/26/02 +0200, Per Einar Ellefsen wrote:
>
>Hello,
>
>I changed some things in Bill's (otherwise excellent) tips section. The
>main point was to change the configuration style to the one most widely
>used in Apache/mod_perl docs, and to fix broken links.
Mostly done already -- just been on the phone all day and haven't had time
to check in.
>- <files hello.cgi>
>+ <Files hello.cgi>
Good.
> For more information on running CGI scripts under mod_perl please see
>-L<mod_perl FAQs|"../../docs/1.0/faqs/index.html">.
>+L<mod_perl FAQs|docs::1.0::faqs::index>.
now in my copy:
For more information on running CGI scripts under mod_perl please see
L<CGI to mod_perl FAQ|faqs::cgi_to_mod_perl> and
L<the CGI to mod_perl Porting section|guide::porting>
of L<The Guide|guide::index>.
I'll hand apply the rest. Thanks.
Regarding duplication:
I have mixed feelings about duplication. For example, I like linking to
the faqs from the start/tips pages (e.g. CGI faq) because they are lighter
weight than linking to the guide. Nicer on the newbie. But it doesn't
make sense to duplicate, and/or use out-dated docs.
There's some value in offering a few different ways to learn.
--
Bill Moseley
mailto:moseley@hank.org
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: [PATCH] tips/
Posted by Stas Bekman <st...@stason.org>.
Bill Moseley wrote:
> At 10:27 PM 04/26/02 +0200, Per Einar Ellefsen wrote:
>
>>I changed some things in Bill's (otherwise excellent) tips section. The
>>main point was to change the configuration style to the one most widely
>>used in Apache/mod_perl docs, and to fix broken links.
>
>
> Sorry for the collision. I just checked in what changes I made earlier
> today, and tried to incorporate everything you suggested, too.
>
> I'm still not thrilled with the writing. Too much use of the word "power",
> for one thing. So any suggestions would be great.
Do we know someone who is a good presenter? I'm sure we should have some
good marketers on the list, but I don't know any. Matt has done a great
AxKit promotion but most through repeating the same thing all the time,
we need something else.
> I don't think it's emphasized enough that mod_perl really can make
> maintaining code easy, and development is fast.
may be by reducing the examples and explanation to the very minimum? The
bigger things you see and the more explanation they require the less
appealing they are at the first sight.
> Should "tips" be renamed "examples"? Does it matter?
Yes, please rename. An intuitive dir/file naming is important for those
who maintain the site. (also having an easy file completion helps,
solved now for /start, Bill)
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: [PATCH] tips/
Posted by Bill Moseley <mo...@hank.org>.
At 10:27 PM 04/26/02 +0200, Per Einar Ellefsen wrote:
>I changed some things in Bill's (otherwise excellent) tips section. The
>main point was to change the configuration style to the one most widely
>used in Apache/mod_perl docs, and to fix broken links.
Sorry for the collision. I just checked in what changes I made earlier
today, and tried to incorporate everything you suggested, too.
I'm still not thrilled with the writing. Too much use of the word "power",
for one thing. So any suggestions would be great.
I don't think it's emphasized enough that mod_perl really can make
maintaining code easy, and development is fast.
Also, on purpose I didn't name specific CPAN modules one might use (e.g.
LDAP) as it's just too huge. But on the other hand, it sometimes doesn't
hurt to throw around buzzwords. Again, I'm open to suggestions. Please.
>I also noticed that many files need to be removed from the repository (in
>src/):
>- start/about.html
>- start/tips/*.html
Done.
Should "tips" be renamed "examples"? Does it matter?
>- start/tips/logging.pod, if it's not going to be used (although it is
>pretty cool).
Just didn't seem very practical. But I forgot to delete it.
--
Bill Moseley
mailto:moseley@hank.org
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org