Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jrouzierinverse committed Feb 17, 2025
1 parent 0ed0f5c commit f2f2740
Show file tree
Hide file tree
Showing 4 changed files with 101 additions and 99 deletions.
3 changes: 2 additions & 1 deletion addons/extract_i18n_strings.pl
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,8 @@ sub parse_conf {
$description =~ s/\"([^\"]+)\"/<i>$1<\/i>/mg; # enclose strings surrounded by double quotes
$description =~ s/\[(\S+)\]/<strong>$1<\/strong>/mg; # enclose strings surrounded by brakets
$description =~ s/(https?:\/\/\S+)/<a href="$1">$1<\/a>/g; # make links clickable
$description =~ s/\n//g;
$description =~ s/\n+$//g;
$description =~ s/\n/ /g;

return $description;
}
Expand Down
8 changes: 4 additions & 4 deletions conf/documentation.conf
Original file line number Diff line number Diff line change
Expand Up @@ -648,7 +648,7 @@ EOT
type=list
description=<<EOT
Address ranges/CIDR blocks that PacketFence will monitor/detect/trap
on. Gateway, network, and broadcast addresses are ignored.
on. Gateway, network, and broadcast addresses are ignored.
Comma-delimited entries should be of the form
* a.b.c.0/24
* a.b.c.0-255
Expand All @@ -659,9 +659,9 @@ EOT
[fencing.whitelist]
type=list
description=<<EOT
Comma-delimited list of MAC addresses that are immune to isolation. In
inline Level 2 enforcement, the firewall is opened for them as if they were
registered. This "feature" will probably be reworked in the future.
Comma-delimited list of MAC addresses that are immune to isolation.
In inline Level 2 enforcement, the firewall is opened for them as if they were registered.
This "feature" will probably be reworked in the future.
EOT

[fencing.passthrough]
Expand Down
3 changes: 2 additions & 1 deletion html/pfappserver/lib/pfappserver/Form/Config/Pf.pm
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ sub field_list {
my $doc_section = $Doc_Config{$doc_section_name};
my $defaults = $Default_Config{$section};
$doc_section->{description} //= '';
$doc_section->{description} =~ s/\n//sg;
$doc_section->{description} =~ s/\n+$//sg;
$doc_section->{description} =~ s/\n/ /sg;
my $doc_anchor = $doc_section->{guide_anchor};
my $doc_anchor_html = defined($doc_anchor) ? " " . pf::web::util::generate_doc_link($doc_anchor) . " " : '';
my $field =
Expand Down
Loading

0 comments on commit f2f2740

Please sign in to comment.