Page 1 of 1

Included Addons FAQ Formatting

PostPosted: Fri Sep 12, 2008 6:19 pm
by XE_ManUp
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:

PostPosted: Fri Sep 12, 2008 11:49 pm
by Saul
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.

Re:

PostPosted: Sat Sep 13, 2008 2:02 am
by XE_ManUp
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?