Difference between revisions of "Administrators"

From Owl
Jump to: navigation, search
Line 1: Line 1:
 
{{FutureRelease}}
 
{{FutureRelease}}
  
== Administrators ==  
+
==Overview==  
  
Owl allows administrators to customize settings for their board and how it is presented in Owl
+
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.
  
Administrators can place ads in the top banned of Owl. Future versions of Owl will allow Administrators to change some view settings and develop plug-ins that can be used with their board through Owl.
+
==Example==
  
== Configuration File: owlconfig.ini ==
+
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:
  
The owlconfig.ini file should be placed in the message board's root folder.
+
<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>!
  
=== owlconfig.ini Options ===
+
[Parser]
 +
name=vbulletin3</source>
  
The following options are valid:
+
==Sections==
 +
 
 +
The following sections are valid within '''<tt>.owlconfig.ini</tt>''':
  
 
== <code>[Ads]</code> Section ==
 
== <code>[Ads]</code> Section ==
Line 24: Line 29:
  
 
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.
 
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> ==
 
 
The parser name of that should be used with the board.
 
 
 
''' Example '''
 
<syntaxhighlight 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>!
 
</syntaxhighlight>
 

Revision as of 23:21, 5 July 2014

Note
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>

Sections

The following sections are valid within .owlconfig.ini:

[Ads] Section

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.