Skip to content

Commit 020c7c7

Browse files
MichaelDecisoAdSchellevis
authored andcommitted
Many typo fixes and some rewording (opnsense#80)
1 parent 86a9787 commit 020c7c7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+151
-152
lines changed

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Some pictures are licensed under the Creative Commons Zero (CC0) license:
3838

3939
https://creativecommons.org/publicdomain/zero/1.0/
4040

41-
# Logo's
42-
Logo's may be subject to additional copyrights, property
41+
# Logos
42+
Logos may be subject to additional copyrights, property
4343
rights, trademarks etc. and may require the consent of a third party or the
4444
license of these rights. Deciso B.V. does not represent or make any warranties
4545
that it owns or licenses any of the mentioned, nor does it grant them.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Some pictures are licensed under the Creative Commons Zero (CC0) license:
2222

2323
https://creativecommons.org/publicdomain/zero/1.0/
2424

25-
Logo's may be subject to additional copyrights, property
25+
Logos may be subject to additional copyrights, property
2626
rights, trademarks etc. and may require the consent of a third party or the
2727
license of these rights. Deciso B.V. does not represent or make any warranties
2828
that it owns or licenses any of the mentioned, nor does it grant them.

source/develop.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Development Manual
77
The OPNsense® project invites developers to start developing with OPNsense:
88
"For your own purpose or even better to join us in creating the best FreeBSD
99
based open source firewall available!" The development workflow & build process
10-
has been redesigned to make it more straightforward and easy for developers to
10+
have been redesigned to make it more straightforward and easy for developers to
1111
build OPNsense.
1212

1313
Being able to get the sources and build it yourself is one of the key factors of

source/development/architecture.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ first layer initializes Phalcon’s routing, which handles requests and
8181
delivers them to the controller based on its url. User content is
8282
generated using Volt templates, which are picked by the controller.
8383
Because Phalcon’s default Models function with (relational) databases
84-
and we are using xml data, our model implementation is custom. But
84+
and we are using XML data, our model implementation is custom. But
8585
wherever possible we use components from Phalcon (for example,
8686
validation is handled using Phalcon’s classes). For a detailed
8787
description on the routing principles used in OPNsense, visit Frontend
@@ -98,7 +98,7 @@ controllers, with the use of views, can be found at :doc:`/development/frontend/
9898
Models
9999
------
100100

101-
All models are defined by a combination of a class and an xml containing
101+
All models are defined by a combination of a class and an XML containing
102102
a (nested) definition. More information on defining models can be found
103103
at the frontend model page :doc:`/development/frontend/models`.
104104

source/development/components/acl.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Using the system from php is rather simple:
4545
Usage in Volt templates
4646
-----------------------
4747

48-
The acl scheme is bound to the default UI controller, and can be used by
48+
The ACL scheme is bound to the default UI controller, and can be used by
4949
using the acl keyword:
5050

5151
.. code-block:: jinja

source/development/components/menusystem.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ An example of how to create a menu, is given below:
3737
// test, print menu as structured named array
3838
print_r($menu->getItems("/testpage.php"));
3939
40-
The current version only implements a static menu defined by one xml file
41-
(models/OPNsense/Base/Menu/Menu.xml), but extending with additional xml files
40+
The current version only implements a static menu defined by one XML file
41+
(models/OPNsense/Base/Menu/Menu.xml), but extending with additional XML files
4242
is already supported in the component for future use.
4343

4444
--------

source/development/examples/helloworld.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Not all modules contain additional code in the php class, sometimes all
120120
the standard behaviour is already sufficient for your
121121
modules/application.
122122

123-
Which is the model xml template, our skeleton starts with something like
123+
Which is the model XML template, our skeleton starts with something like
124124
this:
125125

126126
.. code-block:: xml
@@ -266,9 +266,9 @@ Adding Fields
266266
.. rubric:: Adding fields to your model
267267
:name: adding-fields-to-your-model
268268

269-
When building the skeleton, we have created an empty model (xml), which
269+
When building the skeleton, we have created an empty model (XML), which
270270
we are going to fill with some attributes now. The items section of the
271-
model xml should contain the structure you want to use for your
271+
model XML should contain the structure you want to use for your
272272
application, you can create trees to hold data in here. All leaves
273273
should contain a field type to identify and validate it’s content. The
274274
list of attributes for our application can be translated to this:
@@ -310,12 +310,12 @@ Enabled).
310310
Presentation XML
311311
----------------
312312

313-
.. rubric:: Create a presentation xml to feed your template
313+
.. rubric:: Create a presentation XML to feed your template
314314
:name: create-a-presentation-xml-to-feed-your-template
315315

316316
Because creating forms is one of the key assets of the system, we have
317317
build some easy to use wrappers to guide you through the process. First
318-
we create an xml file for the presentation, which defines fields to use
318+
we create an XML file for the presentation, which defines fields to use
319319
and adds some information for your template to render. Create a file in
320320
your controller directory using the sub directory forms and name it
321321
general.xml. Next copy in the following content:
@@ -392,7 +392,7 @@ Create API calls
392392
:name: create-api-calls-to-retrieve-and-store-data
393393

394394
The framework provides some helpful utilities to get and set data from
395-
and to the configuration xml by using your defined model. First step in
395+
and to the configuration XML by using your defined model. First step in
396396
binding your model to the system is to add a method to the
397397
SettingsController to fetch the data from our configuration (or provide
398398
the defaults if there is no content).
@@ -530,7 +530,7 @@ Let’s give it a try and save our data, without modifying it first.
530530

531531
Next correct the errors and save again, on successful save the data
532532
should be stored in the config.xml. If you want to change validation
533-
messages, just edit the model xml and add your message in the
533+
messages, just edit the model XML and add your message in the
534534
ValidationMessage tag. For example:
535535

536536
.. code-block:: xml
@@ -848,15 +848,15 @@ automatically picks up this new information.
848848
Plugin to access control (ACL)
849849
------------------------------
850850

851-
If we want to authorize users to access this module, we can add an acl
851+
If we want to authorize users to access this module, we can add an ACL
852852
to this module. Without it, only admin users can access it. Create an
853-
xml file in the model directory name ACL/ACL.xml and place the following
853+
XML file in the model directory name ACL/ACL.xml and place the following
854854
content in it:
855855

856856
.. code-block:: xml
857857
858858
<acl>
859-
<!-- unique acl key, must be globally unique for all acl's -->
859+
<!-- unique acl key, must be globally unique for all ACLs -->
860860
<page-user-helloworld>
861861
<name>WebCfg - Users: Hello World! </name>
862862
<description>Allow access to the Hello World! module</description>
@@ -867,7 +867,7 @@ content in it:
867867
</page-user-helloworld>
868868
</acl>
869869
870-
This creates an acl key named “page-user-helloworld” which authorizes
870+
This creates an ACL key named “page-user-helloworld” which authorizes
871871
access to both the ui and API urls of this application. You can now
872872
grant access to this module from the system user manager.
873873

source/development/frontend/models.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Creating Models
44

55
A model represents the data which the application will use and takes
66
care of the interaction to that data. In OPNsense most of the relevant
7-
data is physically stored in an xml structure (config.xml). The primary
7+
data is physically stored in an XML structure (config.xml). The primary
88
goal for OPNsense models is to structure the use of configuration data,
99
by creating a clear abstraction layer.
1010

@@ -44,7 +44,7 @@ When you design a model, the next thing to do is to figure out what data is
4444
relevant for your application or module and think of the rules it should comply
4545
to (for example, if you need an email address you might want to validate the
4646
input). Designing the actual model is as simple as creating an xml file and
47-
putting in your structure, the name of our xml file should be the same as the
47+
putting in your structure, the name of our XML file should be the same as the
4848
base name of our model suffixed by .xml.
4949

5050
Using the same model, we would create the following file:
@@ -91,7 +91,7 @@ Now let's explain what's happing here one tag at a time.
9191
The content of a items tag describes the full tree based structure which holds
9292
our data, in theory this could be as large as you want it to be, but keep in
9393
mind that the content for your model should be logical and understandable. Every
94-
node in the tree could have a type, which defines it's behavior, nodes without a
94+
node in the tree could have a type, which defines its behavior, nodes without a
9595
type are just containers.
9696

9797
From top to bottom we find the following nodes in our tree:

source/development/guidelines/basics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ implementation is one example of this stage.
7878

7979
**3)** Moving on
8080
(re)build new parts, using our new modules, which provide a layered development
81-
system to automatically support API calls from other systems and xml based model
81+
system to automatically support API calls from other systems and XML based model
8282
templates to describe configuration data.
8383

8484
*See also:*

source/development/how-tos/api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Code sample (python)
4141
--------------------
4242

4343
For the python code sample we use the nice "requests" library
44-
(http://docs.python-requests.org/en/latest/), which makes http calls
44+
(http://docs.python-requests.org/en/latest/), which makes HTTP calls
4545
very easy.
4646

4747
Before you can start, make sure your OPNsense has a valid SSL
@@ -102,7 +102,7 @@ Using curl
102102
----------
103103

104104
Simple testing with curl is also possible, the sample below uses the
105-
same credentials, but ignores the ssl certificate check (-k) for
105+
same credentials, but ignores the SSL certificate check (-k) for
106106
testing.
107107

108108
.. code-block:: sh

0 commit comments

Comments
 (0)