Included Addons FAQ Formatting

Post issues or suggestions for the site/forums.

Included Addons FAQ Formatting

Postby XE_ManUp » Fri Sep 12, 2008 6:19 pm

This is just an "idea" for the formatting we can use for the Included Addons FAQ. Prior to getting too far along with it, it would be nice to agree on the formatting. ;)

Description:
<p>Good description of what it does here.</p>


Variables:
<ul>
    <li><code>varname <values | values></code></li>
        <ul>
            <li>Variable description text.</li>
            <li>Location of config (../cfg/gungame/configname.cfg)</li>
        </ul>
    <li><code>varname <values | values></code></li>
        <ul>
            <li>Variable description text.</li>
            <li>Location of config (../cfg/gungame/configname.cfg)</li>
        </ul>
</ul>


Commands:
Variables:
<ul>
    <li><code>CommandName <values | values></code></li>
        <ul>
            <li>Command description text.</li>
        </ul>
    <li><code>CommandName <values | values></code></li>
        <ul>
            <li>Command description text.</li>
        </ul>
</ul>


Files & Directories:
XE_ManUp

Site Admin
Site Admin
 
Posts: 662
Joined: Sat Sep 06, 2008 3:36 am

Postby Saul » Fri Sep 12, 2008 11:49 pm

Hey XE, most of the commands / variable stuff I could probably make a Python script that does generates the HTML automatically, so then you don't have to fill everything in.
Saul

GunGame5 Developer
GunGame5 Developer
 
Posts: 147
Joined: Sun Sep 07, 2008 3:29 pm
Xfire Name: saul0

Re:

Postby XE_ManUp » Sat Sep 13, 2008 2:02 am

Saul wrote:Hey XE, most of the commands / variable stuff I could probably make a Python script that does generates the HTML automatically, so then you don't have to fill everything in.

If you want to, that is fine. I just want everything to look "uniform".

Also, I am curious as to where we should go about documenting/mentioning the files that need to be configured for addons such as gg_admin, gg_welcome_msg, etc. They have a few files that have to be edited for it to work properly. Should we cover that in the "Files & Directories" section?
XE_ManUp

Site Admin
Site Admin
 
Posts: 662
Joined: Sat Sep 06, 2008 3:36 am



Return to Site Administration

Who is online

Users browsing this forum: No registered users and 5 guests