pereinar 2002/06/18 01:39:53
Modified: src/docs config.cfg
Added: src/docs conventions.pod
Log:
Added conventions: prompts and typographical ones. Any more?
Revision Changes Path
1.14 +6 -0 modperl-docs/src/docs/config.cfg
Index: config.cfg
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/config.cfg,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- config.cfg 10 Jun 2002 22:35:35 -0000 1.13
+++ config.cfg 18 Jun 2002 08:39:53 -0000 1.14
@@ -11,6 +11,12 @@
mod_perl, you'll learn it here.
EOB
+ group => 'Introduction',
+
+ chapters => [qw(
+ conventions.pod
+ )],
+
group => 'mod_perl 1.0 Documentation',
docsets => [qw(
1.1 modperl-docs/src/docs/conventions.pod
Index: conventions.pod
===================================================================
=head1 NAME
Conventions used in the mod_perl Documentation
=head1 Description
We use a number of conventions in this documentation, that are mostly
easy to understand; if you're in doubt, look here for the explanation.
=head1 Prompts
For commands that should be typed in your shell (or your I<Command
prompt>, or whatever your OS calls it), we use the following prompts:
% ls -l
for the user-mode prompt (ie. a normal user account, with no special
privileges).
# ls -l
for the superuser prompt: this means you'll have to change users to
become the super user on your platform. On Unix you can use the C<su>
or C<sudo> utilities to gain superuser privileges (provided you know
the I<root> password); on other platforms you might have to change the
user -- to I<Administrator> for example on Windows.
If you cannot obtain super user privileges, there will often be
explanations about how doing the selected task without those
privileges; in any other case, contact your system administrator.
On documents specific to a certain Operating System, the prompt might
change. For example, in Windows documentation, we might use:
C:\> nmake
instead of any other prompt.
=head1 Typographical conventions
We try to be consisten about our use of different fonts and faces, so
that you'll recognize special words more easily.
=over
=item *
I<Italic>
is used for file names or things you have to replace.
=item *
C<Constant width>
is used for commands/program names, configuration items or Perl
code/function names, and manpage references.
=item *
B<Bold>
is used for things we want to stress.
=back
=cut
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
