Skip to content

Commit

Permalink
Item13883: docu fixes
Browse files Browse the repository at this point in the history
* fixed javascript errors in FormatTokens
* fixed TML escaping in PerlDependencyReport
* removed inline css styling from foswikiHelp div
* typographic format errors in VarREVINFO
  • Loading branch information
MichaelDaum committed Feb 26, 2016
1 parent ebfe80c commit c345d99
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 28 deletions.
4 changes: 3 additions & 1 deletion core/data/System/Category.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
%META:TOPICINFO{author="ProjectContributor" date="1434485265" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1456498557" format="1.1" reprev="1" version="1"}%
---+!! %TOPIC%
%STARTINCLUDE%
%SEARCH{"parent.name='%BASETOPIC%'" web="%BASEWEB%" type="query"
nonoise="on" format=" $dollar [[$topic]] : $pattern(.*?---[^\n]+\n+([^\n]*).*)"}%

Expand Down
2 changes: 1 addition & 1 deletion core/data/System/CompleteDocumentation.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1456497941" format="1.1" reprev="1" version="1"}%
---+!! Reference Manual (%WIKIVERSION%)

This page contains all documentation topics as one long, complete reference sheet.
Expand Down
7 changes: 4 additions & 3 deletions core/data/System/FormatTokens.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1416592876" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1456498233" format="1.1" reprev="1" version="1"}%
%META:TOPICPARENT{name="FormattedSearch"}%
---++ Formatting Tokens

Expand All @@ -24,7 +24,8 @@ Click the buttons below to escape or unescape the sample text.
$ & < > % , "
</textarea>
%CLEAR%
%BUTTON{"Escape" onclick="$('#tmlForEscape').val(foswiki.String.escapeTML( $('#tmlForEscape').val() )); return false"}%
%BUTTON{"Unescape" onclick="$('#tmlForEscape').val(foswiki.String.unescapeTML( $('#tmlForEscape').val() )); return false"}%
%BUTTON{"Escape" onclick="jQuery('#tmlForEscape').val(foswiki.String.escapeTML( jQuery('#tmlForEscape').val() )); return false"}%
%BUTTON{"Unescape" onclick="jQuery('#tmlForEscape').val(foswiki.String.unescapeTML( jQuery('#tmlForEscape').val() )); return false"}%
%CLEAR%
</form>
%TMPL:P{"JavascriptFiles/foswikiString"}%
7 changes: 2 additions & 5 deletions core/data/System/InstallationGuide.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
%META:TOPICINFO{author="ProjectContributor" date="1454455735" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1456498557" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
<noautolink>
---+!! Installation Guide
<div class='foswikiHelp' style='border:2px orange solid' >
<div class='foswikiHelp'>
This guide describes the steps for installing Foswiki, with __specific steps for installations on Linux with the Apache web server__.%BR%
If you would prefer to use a different web server, please refer to supplemental documentation when you reach the Apache-specific steps:
* *Nginx:* [[http://foswiki.org/Support/FoswikiOnNginx][Foswiki on Nginx]]
Expand Down Expand Up @@ -229,15 +229,13 @@ perl tools/dependencies </verbatim>
* Ask for help on [[Foswiki:Community.InternetRelayChat][IRC]] (irc.freenode.net, channel #foswiki). There are often a number of people waiting to help.
* Ask a question in the Foswiki:Support web


---++ Supplemental Information For Installation

#SystemRequirements
---+++ System Requirements

%INCLUDE{"SystemRequirements"}%


#UploadingFoswikiDistribution
---+++ Uploading the Foswiki distribution to your web server host

Expand Down Expand Up @@ -415,7 +413,6 @@ If a plugin exists both in a TWiki version and a Foswiki version, it is strongly
#TWikiTrademark
TWiki is a registered trademark of Peter Thoeny.


*Related Topics:* %IF{"$skin = 'plain'" then="<nop>System.<nop>InstallationGuidePart2 in your installation" else="[[InstallationGuidePart2]]"}%, %IF{"$skin = 'plain'" then="<nop>System.<nop>AdminDocumentationCategory in your installation" else="[[AdminDocumentationCategory]]"}%, Foswiki:Support.SupplementalDocuments

<!-- %JQREQUIRE{"chili"}% -->
Expand Down
28 changes: 14 additions & 14 deletions core/data/System/PerlDependencyReport.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1449100641" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1456497986" format="1.1" reprev="1" version="1"}%
%META:TOPICPARENT{name="InstallationGuide"}%
---+!! Perl dependencies for Foswiki and Extensions

Expand All @@ -16,19 +16,18 @@ resolution. Optional or "recommended" dependencies will note when they are
needed, and should only be installed if you know that your particular
installation will require them.</div>

%IF{"$include='all'" else="
%BUTTON{
"Show all dependencies"
icon="book"
onclick="window.location.href='%SCRIPTURL{"view"}%/%WEB%/%TOPIC%?include=all';"
}%" then="
%BUTTON{
"Show only missing dependencies"
icon="book"
onclick="window.location.href='%SCRIPTURL{"view"}%/%WEB%/%TOPIC%?include=missing';"
}%
"}%

%IF{"$include='all'"
else="$percntBUTTON{
\"Show all dependencies\"
icon=\"book\"
onclick=\"window.location.href='%SCRIPTURL{"view"}%/%WEB%/%TOPIC%?include=all';\"
}$percnt"
then="$percntBUTTON{
\"Show only missing dependencies\"
icon=\"book\"
onclick=\"window.location.href='%SCRIPTURL{"view"}%/%WEB%/%TOPIC%?include=missing';\"
}$percnt"
}%

%TOC%

Expand All @@ -43,4 +42,5 @@ Note: If a minimum version is identified, the extension requiring the highest mi

%PERLDEPENDENCYREPORT{"extensions" include="%URLPARAM{"include" default="missing"}%"}%
</noautolink>

%META:PREFERENCE{name="CACHEABLE" title="CACHEABLE" type="Set" value="off"}%
8 changes: 4 additions & 4 deletions core/data/System/VarREVINFO.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1437230349" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1456498557" format="1.1" reprev="1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ REVINFO -- revision information of current topic
=%<nop>REVINFO%= is equivalent to =%<nop>REVINFO{format="r1.$rev - $date - $wikiusername"}%=
Expand All @@ -8,9 +8,9 @@
---++ Parameters
%TABLE{sort="off"}%
| *Parameter* | *Description* | *Default* |
| ="format"= | Format of revision information, see supported formatting tokens below | ="r$rev - $date - $wikiusername"= |
| =web=" | Name of web | Current web |
| =topic=" | Topic name | Current topic |
| =format= | Format of revision information, see supported formatting tokens below | ="r$rev - $date - $wikiusername"= |
| =web= | Name of web | Current web |
| =topic= | Topic name | Current topic |
| =rev= | Specific revision number | Latest revision |
Supported formatting tokens:
%TABLE{sort="off"}%
Expand Down

0 comments on commit c345d99

Please sign in to comment.