Difference between revisions of "Administrators"
(→Configuration File: owlconfig.ini) |
(→Details) |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{FutureRelease}} | |
| − | + | ==Overview== | |
| − | Administrators can place ads | + | Owl allows administrators to customize settings for their board and how it is presented in Owl. Administrators can also define custom parsers and extensions to be used on their board, as well as place ads within the Owl UI. The '''<tt>.owlconfig.ini</tt>''' is a text file that stores these settings. This file can (optionally) be created by the board administrators and should be placed in the forum's root folder. Hence, if the the full URL to the board is http://www.juot.net/boards/myboard then the '''<tt>.owlconfig.ini</tt>''' file should be accessible by going to http://www.juot.net/boards/myboard/.owlconfig.ini. |
| − | == | + | ==Example== |
| − | The | + | The follow example defines the top and bottom ads displayed in Owl when viewing the message board and defines the custom parser that should be used when adding the board to Owl for the first time: |
| − | === | + | <source lang="ini">[Ads] |
| + | ad.top=Visit our store for great deals and merchandise! <a href="http://www.juot.net/store">JUOT Store!</a> | ||
| + | ad.bottom=Check out our network partner at <a href="http://www.anothermessageboard.com">anothermessageboard.com</a>! | ||
| − | + | [Parser] | |
| + | name=vbulletin3</source> | ||
| − | == | + | ==Details== |
| − | + | These are the sections and settings used: | |
| − | Text to be displayed in the top yellow ad portion of Owl. The only HTML allowed is one <a> link, all other HTML will be ignored. | + | ;<code>[Ads]</code> |
| + | : This section defines which ads appear in what parts of the UI. | ||
| + | :;<code>ad.top</code> | ||
| + | ::Text to be displayed in the top yellow ad portion of Owl. The only HTML allowed is one <a> link, all other HTML will be ignored. | ||
| + | :;<code>ad.bottom</code> | ||
| + | ::Text to be displayed in the bottom light blue ad portion of Owl. The only HTML allowed is one <a> link, all other HTML will be ignored. | ||
| − | + | ;<code>[Parser]</code> | |
| − | + | :This section can define either the name of the parser to be used or define a path to a custom parser that will be downloaded and used. | |
| − | + | :;<code>name</code> | |
| + | ::The name of the Parser to use. If the Parser does not exist on in Owl, an error will be generated and the board will not be added to Owl. | ||
| + | :;<code>url</code> | ||
| + | ::The URL to the Parser file. Owl will attempt to download the file and then use that as the Parser for the message board. If there are any errors, the board will not be added to Owl. | ||
Latest revision as of 23:27, 5 July 2014
 |
Upcoming Release Some or all of the features mentioned in this article may not be present in the current public release of Owl. |
Overview
Owl allows administrators to customize settings for their board and how it is presented in Owl. Administrators can also define custom parsers and extensions to be used on their board, as well as place ads within the Owl UI. The .owlconfig.ini is a text file that stores these settings. This file can (optionally) be created by the board administrators and should be placed in the forum's root folder. Hence, if the the full URL to the board is http://www.juot.net/boards/myboard then the .owlconfig.ini file should be accessible by going to http://www.juot.net/boards/myboard/.owlconfig.ini.
Example
The follow example defines the top and bottom ads displayed in Owl when viewing the message board and defines the custom parser that should be used when adding the board to Owl for the first time:
<source lang="ini">[Ads] ad.top=Visit our store for great deals and merchandise! <a href="http://www.juot.net/store">JUOT Store!</a> ad.bottom=Check out our network partner at <a href="http://www.anothermessageboard.com">anothermessageboard.com</a>!
[Parser] name=vbulletin3</source>
Details
These are the sections and settings used:
[Ads]- This section defines which ads appear in what parts of the UI.
ad.top- Text to be displayed in the top yellow ad portion of Owl. The only HTML allowed is one <a> link, all other HTML will be ignored.
ad.bottom- Text to be displayed in the bottom light blue ad portion of Owl. The only HTML allowed is one <a> link, all other HTML will be ignored.
[Parser]- This section can define either the name of the parser to be used or define a path to a custom parser that will be downloaded and used.
name- The name of the Parser to use. If the Parser does not exist on in Owl, an error will be generated and the board will not be added to Owl.
url- The URL to the Parser file. Owl will attempt to download the file and then use that as the Parser for the message board. If there are any errors, the board will not be added to Owl.
