Commit ad597297 authored by sikeda's avatar sikeda
Browse files

[-dev] Copyedit on documentation.


git-svn-id: https://subversion.renater.fr/sympa/branches/sympa-6.2-branch@12713 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent 53567aeb
......@@ -389,40 +389,10 @@ For malformed inputs returns C<undef>.
Returns canonical form of message ID without trailing or leading whitespaces
or C<E<lt>>, C<E<gt>>.
=item wrap_text ( $text, [ $init_tab, [ $subsequent_tab, [ $cols ] ] ] )
I<Function>.
Returns line-wrapped text.
Parameters:
=over
=item $text
The text to be folded.
=item $init_tab
Indentation prepended to the first line of paragraph.
Default is C<''>, no indentation.
=item $subsequent_tab
Indentation prepended to each subsequent line of folded paragraph.
Default is C<''>, no indentation.
=item $cols
Max number of columns of folded text.
Default is C<78>.
=back
=item decode_html ( $str )
=item decode_filesystem_safe ( $str )
I<Function>.
Decodes HTML entities in a string encoded by UTF-8 or a Unicode string.
Decodes a string encoded by encode_filesystem_safe().
Parameter:
......@@ -438,10 +408,10 @@ Returns:
Decoded string, stripped C<utf8> flag if any.
=item decode_filesystem_safe ( $str )
=item decode_html ( $str )
I<Function>.
Decodes a string encoded by encode_filesystem_safe().
Decodes HTML entities in a string encoded by UTF-8 or a Unicode string.
Parameter:
......@@ -457,11 +427,10 @@ Returns:
Decoded string, stripped C<utf8> flag if any.
=item encode_html ( $str )
=item encode_filesystem_safe ( $str )
I<Function>.
Encodes characters in a string $str to HTML entities.
C<'E<lt>'>, C<'E<gt>'>, C<'E<amp>'> and C<'E<quot>'> are encoded.
Encodes a string $str to be suitable for filesystem.
Parameter:
......@@ -475,12 +444,18 @@ String to be encoded.
Returns:
Encoded string, I<not> stripping utf8 flag if any.
Encoded string, stripped C<utf8> flag if any.
All bytes except C<'-'>, C<'+'>, C<'.'>, C<'@'>
and alphanumeric characters are encoded to sequences C<'_'> followed by
two hexdigits.
=item encode_filesystem_safe ( $str )
Note that C<'/'> will also be encoded.
=item encode_html ( $str )
I<Function>.
Encodes a string $str to be suitable for filesystem.
Encodes characters in a string $str to HTML entities.
C<'E<lt>'>, C<'E<gt>'>, C<'E<amp>'> and C<'E<quot>'> are encoded.
Parameter:
......@@ -494,16 +469,13 @@ String to be encoded.
Returns:
Encoded string, stripped C<utf8> flag if any.
All bytes except C<'-'>, C<'+'>, C<'.'>, C<'@'>
and alphanumeric characters are encoded to sequences C<'_'> followed by
two hexdigits.
Note that C<'/'> will also be encoded.
Encoded string, I<not> stripping utf8 flag if any.
=item encode_uri ( $str, [ omit => $chars ] )
TBD
I<Function>.
Encodes potentially unsafe characters in the string using "percent" encoding
suitable for URIs.
Parameters:
......@@ -563,6 +535,7 @@ A string.
=item mailtourl ( $email, [ decode_html =E<gt> 1 ],
[ query =E<gt> {key =E<gt> val, ...} ] )
I<Function>.
Constructs a C<mailto:> URL for given e-mail.
Parameters:
......@@ -614,6 +587,36 @@ L</decode_filesystem_safe>.
Basic check of an email address.
=item wrap_text ( $text, [ $init_tab, [ $subsequent_tab, [ $cols ] ] ] )
I<Function>.
Returns line-wrapped text.
Parameters:
=over
=item $text
The text to be folded.
=item $init_tab
Indentation prepended to the first line of paragraph.
Default is C<''>, no indentation.
=item $subsequent_tab
Indentation prepended to each subsequent line of folded paragraph.
Default is C<''>, no indentation.
=item $cols
Max number of columns of folded text.
Default is C<78>.
=back
=back
=head1 HISTORY
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment