Difference between revisions of "SMF Files and Their Meanings"

From Online Manual

Jump to: navigation, search
m (1 revision)
m (Themes)
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
SMF Files and Their Meanings
+
{{TOCright}}
 +
==Root==
 +
The root directory of the forum.
  
'''Root'''
+
*'''agreement.txt''' - What registrars have to agree by in order to successfully [[Register]] on any SMF forum, when the "Show and require agreement letter when registering" option enabled.
 +
*'''index.php''' - The file used to show your forum to visitors.
 +
*'''install.php''' - The file used to setup the initial SMF forum. This file configures database information, [[Forum]] information and the initial administrator's account. Can be a security threat if left dormant.
 +
*'''upgrade.php''' - Upgrades any version of an SMF [[Forum]] to a newer version. Can be a security threat if left dormant.
 +
*'''repair_settings.php''' - Edits the paths to different directories, URLs and database connection information. Can be a security threat if left dormant.
 +
*'''license.txt''' - As the operator of an SMF forum, you have to agree to the terms contained in this file.
 +
*'''Settings.php''' - Contains information about the forum, server settings, database connection information, etc.
 +
*'''Settings_bak.php''' - A backup of "Settings.php".
 +
*'''SSI.php''' - Some functions from your [[Forum]] to be used on your website, if you wish (i.e. login system, show last posts, etc.).
 +
*'''ssi_examples.php''' - Examples of how to integrate SSI's functions in a PHP file.
 +
*'''ssi_examples.shtml''' - Examples of how to integrate SSI's functions in an SHTML file.
 +
*'''readme.html''' - A wealth of information about SMF, what's required to it, etc.
  
agreement.txt - What registrars have to agree by in order to successfully [[Register]] on any SMF forum, when the "Show and require agreement letter when registering" option enabled.
+
==attachments==
 +
The directory where attachments are stored in a default installtion.
  
index.php - The file used to show your [[Forum]] to visitors.
+
*'''index.php''' - Does not allow contents of the directory to be listed.
  
install.php - The file used to setup the initial SMF forum. This file configures database information, [[Forum]] information and the initial administrator's account. Can be a security threat if left dormant.
+
==avatars==
 +
The directory where avatar packages are stored. Avatars uploaded by users are instead stored in the [[#attachments]] directory.
  
upgrade.php - Upgrades any version of an SMF [[Forum]] to a newer version. Can be a security threat if left dormant.
+
*'''index.php''' - Does not allow contents of the directory to be listed.
  
repair_settings.php - Edits the paths to different directories, URLs and database connection information. Can be a security threat if left dormant.
+
==cache==
 +
In this directory are stored files generated by SMF for caching informations.
  
license.txt - As the operator of an SMF forum, you have to agree to the terms contained in this file.
+
*'''index.php''' - Does not allow contents of the directory to be listed.
  
Settings.php - Contains information about the forum, server settings, database connection information, etc.
+
==Packages==
 +
In this directory are stored the packages to be used through the [[package manager]].
  
Settings_bak.php - A backup of "Settings.php".
+
*'''index.php''' - Does not allow contents of the directory to be listed.
 +
*'''installed.list''' - The list of currently installed packages (packages installed through the Package Manager).
 +
*'''server.list''' - A list of packages' servers to which you can connect and get new or updated packages.
 +
*'''backup''' - A directory where are store the backups created by SMF every time a [[Modification|mod]] is installed or removed.
  
SSI.php - Some functions from your [[Forum]] to be used on your website, if you wish (i.e. login system, show last posts, etc.).
+
==Smileys==
 +
Here are stored the smiley packs, one per each subdirectory.
  
ssi_examples.php - Examples of how to integrate SSI's functions in a PHP file.
+
*'''index.php''' - Does not allow contents of the directory to be listed.
  
ssi_examples.shtml - Examples of how to integrate SSI's functions in an SHTML file.
+
==Sources==
 +
In this directory are stored the ''core'' files of SMF.
  
readme.html - A wealth of information about SMF, what's required to it, etc.
+
*'''Admin.php''' - A file that handles basic administration.
 +
*'''BoardIndex.php''' - Used to display the [[Board]] index.
 +
*'''Calendar.php''' - Displays the calendar.
 +
*'''Class-Graphics.php''' -
 +
*'''Class-Packages.php -
 +
*'''DbExtra-mysql.php''' -
 +
*'''DbExtra-postgresql.php''' -
 +
*'''DbExtra-sqlite.php''' -
 +
*'''DbPackages-mysql.php''' -
 +
*'''DbPackages-postgresql.php''' -
 +
*'''DbPackages-sqlite.php''' -
 +
*'''DbSearch-mysql.php''' -
 +
*'''DbSearch-postgresql.php''' -
 +
*'''DbSearch-sqlite.php''' -
 +
*'''Display.php''' - This file controls topic, message and [[Attachment]] display.
 +
*'''DumpDatabase.php''' - Used to backup an SMF forum's SQL database through the admin panel.
 +
*'''Errors.php''' - Logs [[Forum]] and database errors.
 +
*'''Groups.php''' -
 +
*'''Help.php''' - This file takes care of help messages and the help center.
 +
*'''index.php''' - Does not allow contents of the directory to be listed.
 +
*'''Karma.php''' - Handles the "karma" feature in SMF.
 +
*'''Load.php''' - The file used to load nearly every page of an SMF forum.
 +
*'''LockTopic.php''' - Handles the locking and stickying of topics.
 +
*'''LogInOut.php''' - File used to log members in and out.
 +
*'''ManageAttachments.php''' - Handles the managing of attachments.
 +
*'''ManageBans.php''' -
 +
*'''ManageBoards.php''' - Manage your forum's boards (create, edit and remove boards, assign moderators to boards, authorize access to boards to certain membergroups, etc.).
 +
*'''ManageCalendar.php''' -
 +
*'''ManageErrors.php''' -
 +
*'''ManageMail.php''' -
 +
*'''ManageMaintenance.php''' -
 +
*'''ManageMembergroups''' -
 +
*'''ManageMembers.php''' - Handles the managing of members.
 +
*'''ManageNews.php''' -
 +
*'''ManagePaid.php''' -
 +
*'''ManagePermissions.php''' - Handles the managing of permissions.
 +
*'''ManagePosts.php''' -
 +
*'''ManageRegistration.php''' -
 +
*'''ManageScheduledTasks.php''' -
 +
*'''ManageSearch.php''' -
 +
*'''ManageSearchEngins.php''' -
 +
*'''MAnageServer.php''' -
 +
*'''ManageSettings.php''' -
 +
*'''ManageSmileys.php''' - Handles the managing of smileys.
 +
*'''Memberlist.php''' - contains the functions for displaying and searching in the members list.
 +
*'''MessageIndex.php''' - Shows the listing of topics in a board.
 +
*'''ModerationCenter.php''' -
 +
*'''Modlog.php''' - Controls the moderation log.
 +
*'''MoveTopic.php''' - Contains the functions required to move topics from one [[Board]] to another board.
 +
*'''News.php''' - Contains the files necessary to display news as an XML feed.
 +
*'''Notify.php''' - Controls the toggling of notifications.
 +
*'''PackageGet.php''' - Tool used by the Package Manager to retrieve package files.
 +
*'''Packages.php''' - The Package Manager of SMF.
 +
*'''PersonalMessage.php''' -
 +
*'''Poll.php''' - Contains the functions for voting, locking, removing and editing polls.
 +
*'''Post.php''' - Handles everything related to posting replies, new topics, quotes and modifications to existing posts. Also handles quoting posts by way of a popup.
 +
*'''PostModeration.php''' -
 +
*'''Printpage.php''' - File used to format a [[Topic]] to make it printer-friendly.
 +
*'''Profile-Actions.php''' -
 +
*'''Profile-Modify.php''' -
 +
*'''Profile-View.php''' -
 +
*'''Profile.php''' - Handles user profiles.
 +
*'''QueryString.php''' - Handles the query string, request variables and session management.
 +
*'''Recent.php''' - Finds and retrieves information about recently posted topics, messages, etc.
 +
*'''Register.php''' - Manages registrations.
 +
*'''Reminder.php''' - Used to send members password reminders.
 +
*'''RemoveTopic.php''' - Used to completely remove an entire topic.
 +
*'''RepairBoards.php''' - Used when searching for and repairing data errors or corruption.
 +
*'''Reports.php''' -
 +
*'''ScheduledTasks.php''' -
 +
*'''Search.php''' - Files used to search an SMF forum.
 +
*'''SearchAPI-Custom.php''' -
 +
*'''SearchAPI-Fulltext.php''' -
 +
*'''SearchAPI-Standard.php''' -
 +
*'''Security.php''' - Insures [[Forum]] security.
 +
*'''SendTopic.php''' - File that deals with sending topics to a friend.
 +
*'''SplitTopics.php''' - This file handles merging and splitting topics.
 +
*'''Stats.php''' - Provides a display for [[Forum]] statistics.
 +
*'''Subs-Admin.php''' -
 +
*'''Subs-Auth.php''' - Handles authentication, user handling, etc.
 +
*'''Subs-BoardIndex.php''' -
 +
*'''Subs-Boards.php''' - Handles marking boards and topics read, collapsing categories and quick moderation.
 +
*'''Subs-Calendar.php''' -
 +
*'''Subs-Category.php''' -
 +
*'''Subs-Charset.php''' -
 +
*'''Subs-Compat.php''' -
 +
*'''Subs-Db-mysql.php''' -
 +
*'''Subs-Db-postgresql.php''' -
 +
*'''Subs-Db-sqlite.php''' -
 +
*'''Subs-Editor.php''' -
 +
*'''Subs-Graphics.php''' - Handles all aspects of users' avatars.
 +
*'''Subs-List.php''' -
 +
*'''Subs-Membergroups.php''' -
 +
*'''Subs-Members.php''' -
 +
*'''Subs-MembersOnline.php''' -
 +
*'''Subs-Menu.php''' -
 +
*'''Subs-MessageIndex.php''' -
 +
*'''Subs-OpenID.php''' -
 +
*'''Subs-Package.php''' - Contains functions for handling .tar.gz and .zip files, as well as a simple XML parser to handle the XML package stuff. Not to mention a few functions to make file handling easier.
 +
*'''Subs-Post.php''' - This file contains those functions pertaining to posting and other such operations, including sending emails, IMs, blocking spam, preparsing posts, spell checking and the [[Post]] box.
 +
*'''Subs-Recent.php''' -
 +
*'''Subs-Sound.php''' -
 +
*'''Subs.php''' - Contains many of the general-use functions the [[Forum]] needs to work.
 +
*'''Subscriptions-PayPal.php''' -
 +
*'''Themes.php''' - Handles [[Theme]] administration.
 +
*'''ViewQuery.php''' - This file is concerned with viewing queries and is used for debugging.
 +
*'''Who.php''' - Handles the "Who's Online" list.
 +
*'''Xml.php''' -
  
'''Attachments'''
+
==Themes==
 +
In this directory are contained all the [[Theme|themes]] installed in the forum, one theme for each subdirectory.
  
index.php - Does not allow contents of the directory to be listed.
+
*'''index.php''' - Does not allow contents of the directory to be listed.
  
'''Avatars'''
+
[[Category:Developing SMF]]
 
+
[[Category:Customizing SMF]]
index.php - Does not allow contents of the directory to be listed.
+
[[Category:As an administrator]]
 
 
'''Packages'''
 
 
 
index.php - Does not allow contents of the directory to be listed.
 
 
 
installed.list - The list of currently installed packages (packages installed through the Package Manager).
 
 
 
server.list - A list of packages' servers to which you can connect and get new or updated packages.
 
 
 
'''Smileys'''
 
 
 
index.php - Does not allow contents of the directory to be listed.
 
 
 
'''Sources'''
 
 
 
Admin.php - A file that handles basic administration.
 
 
 
BoardIndex.php - Used to display the [[Board]] index.
 
 
 
Calendar.php - Displays the calendar.
 
 
 
Display.php - This file controls topic, message and [[Attachment]] display.
 
 
 
DumpDatabase.php - Used to backup an SMF forum's SQL database through the admin panel.
 
 
 
Errors.php - Logs [[Forum]] and database errors.
 
 
 
Help.php - This file takes care of help messages and the help center.
 
 
 
index.php - Does not allow contents of the directory to be listed.
 
 
 
InstantMessage.php - Handles most aspects of personal messages.
 
 
 
Karma.php - Handles the "karma" feature in SMF.
 
 
 
Load.php - The file used to load nearly every page of an SMF forum.
 
 
 
LockTopic.php - Handles the locking and stickying of topics.
 
 
 
LogInOut.php - File used to log members in and out.
 
 
 
ManageAttachments.php - Handles the managing of attachments.
 
 
 
ManageBoards.php - Manage your forum's boards (create, edit and remove boards, assign moderators to boards, authorize access to boards to certain membergroups, etc.).
 
 
 
ManageMembers.php - Handles the managing of members.
 
 
 
ManagePermissions.php - Handles the managing of permissions.
 
 
 
ManageSmileys.php - Handles the managing of smileys.
 
 
 
Memberlist.php - contains the functions for displaying and searching in the members list.
 
 
 
MessageIndex.php - Shows the listing of topics in a board.
 
 
 
Modlog.php - Controls the moderation log.
 
 
 
ModSettings.php - This file is here to make it easier for installed mods to have settings and options.
 
 
 
MoveTopic.php - Contains the functions required to move topics from one [[Board]] to another board.
 
 
 
News.php - Contains the files necessary to display news as an XML feed.
 
 
 
Notify.php - Controls the toggling of notifications.
 
 
 
PackageGet.php - Tool used by the Package Manager to retrieve package files.
 
 
 
Packages.php - The Package Manager of SMF.
 
 
 
Poll.php - Contains the functions for voting, locking, removing and editing polls.
 
 
 
Post.php - Handles everything related to posting replies, new topics, quotes and modifications to existing posts. Also handles quoting posts by way of a popup.
 
 
 
Printpage.php - File used to format a [[Topic]] to make it printer-friendly.
 
 
 
Profile.php - Handles user profiles.
 
 
 
QueryString.php - Handles the query string, request variables and session management.
 
 
 
Recent.php - Finds and retrieves information about recently posted topics, messages, etc.
 
 
 
Register.php - Manages registrations.
 
 
 
Reminder.php - Used to send members password reminders.
 
 
 
RemoveTopic - Used to completely remove an entire topic.
 
 
 
RepairBoards.php - Used when searching for and repairing data errors or corruption.
 
 
 
Search.php - Files used to search an SMF forum.
 
 
 
Security.php - Insures [[Forum]] security.
 
 
 
SendTopic.php - File that deals with sending topics to a friend.
 
 
 
SplitTopics.php - This file handles merging and splitting topics.
 
 
 
Stats.php - Provides a display for [[Forum]] statistics.
 
 
 
Subs.php - Contains many of the general-use functions the [[Forum]] needs to work.
 
 
 
Subs-Auth.php - Handles authentication, user handling, etc.
 
 
 
Subs-Boards.php - Handles marking boards and topics read, collapsing categories and quick moderation.
 
 
 
Subs-Graphics.php - Handles all aspects of users' avatars.
 
 
 
Subs-Package.php - Contains functions for handling .tar.gz and .zip files, as well as a simple XML parser to handle the XML package stuff. Not to mention a few functions to make file handling easier.
 
 
 
Subs-Post.php - This file contains those functions pertaining to posting and other such operations, including sending emails, IMs, blocking spam, preparsing posts, spell checking and the [[Post]] box.
 
 
 
Themes.php - Handles [[Theme]] administration.
 
 
 
ViewQuery.php - This file is concerned with viewing queries and is used for debugging.
 
 
 
Who.php - Handles the "Who's Online" list.
 
 
 
'''Themes'''
 
 
 
index.php - Does not allow contents of the directory to be listed.
 

Latest revision as of 18:26, 22 October 2014

Root

The root directory of the forum.

  • agreement.txt - What registrars have to agree by in order to successfully Register on any SMF forum, when the "Show and require agreement letter when registering" option enabled.
  • index.php - The file used to show your forum to visitors.
  • install.php - The file used to setup the initial SMF forum. This file configures database information, Forum information and the initial administrator's account. Can be a security threat if left dormant.
  • upgrade.php - Upgrades any version of an SMF Forum to a newer version. Can be a security threat if left dormant.
  • repair_settings.php - Edits the paths to different directories, URLs and database connection information. Can be a security threat if left dormant.
  • license.txt - As the operator of an SMF forum, you have to agree to the terms contained in this file.
  • Settings.php - Contains information about the forum, server settings, database connection information, etc.
  • Settings_bak.php - A backup of "Settings.php".
  • SSI.php - Some functions from your Forum to be used on your website, if you wish (i.e. login system, show last posts, etc.).
  • ssi_examples.php - Examples of how to integrate SSI's functions in a PHP file.
  • ssi_examples.shtml - Examples of how to integrate SSI's functions in an SHTML file.
  • readme.html - A wealth of information about SMF, what's required to it, etc.

attachments

The directory where attachments are stored in a default installtion.

  • index.php - Does not allow contents of the directory to be listed.

avatars

The directory where avatar packages are stored. Avatars uploaded by users are instead stored in the #attachments directory.

  • index.php - Does not allow contents of the directory to be listed.

cache

In this directory are stored files generated by SMF for caching informations.

  • index.php - Does not allow contents of the directory to be listed.

Packages

In this directory are stored the packages to be used through the package manager.

  • index.php - Does not allow contents of the directory to be listed.
  • installed.list - The list of currently installed packages (packages installed through the Package Manager).
  • server.list - A list of packages' servers to which you can connect and get new or updated packages.
  • backup - A directory where are store the backups created by SMF every time a mod is installed or removed.

Smileys

Here are stored the smiley packs, one per each subdirectory.

  • index.php - Does not allow contents of the directory to be listed.

Sources

In this directory are stored the core files of SMF.

  • Admin.php - A file that handles basic administration.
  • BoardIndex.php - Used to display the Board index.
  • Calendar.php - Displays the calendar.
  • Class-Graphics.php -
  • Class-Packages.php -
  • DbExtra-mysql.php -
  • DbExtra-postgresql.php -
  • DbExtra-sqlite.php -
  • DbPackages-mysql.php -
  • DbPackages-postgresql.php -
  • DbPackages-sqlite.php -
  • DbSearch-mysql.php -
  • DbSearch-postgresql.php -
  • DbSearch-sqlite.php -
  • Display.php - This file controls topic, message and Attachment display.
  • DumpDatabase.php - Used to backup an SMF forum's SQL database through the admin panel.
  • Errors.php - Logs Forum and database errors.
  • Groups.php -
  • Help.php - This file takes care of help messages and the help center.
  • index.php - Does not allow contents of the directory to be listed.
  • Karma.php - Handles the "karma" feature in SMF.
  • Load.php - The file used to load nearly every page of an SMF forum.
  • LockTopic.php - Handles the locking and stickying of topics.
  • LogInOut.php - File used to log members in and out.
  • ManageAttachments.php - Handles the managing of attachments.
  • ManageBans.php -
  • ManageBoards.php - Manage your forum's boards (create, edit and remove boards, assign moderators to boards, authorize access to boards to certain membergroups, etc.).
  • ManageCalendar.php -
  • ManageErrors.php -
  • ManageMail.php -
  • ManageMaintenance.php -
  • ManageMembergroups -
  • ManageMembers.php - Handles the managing of members.
  • ManageNews.php -
  • ManagePaid.php -
  • ManagePermissions.php - Handles the managing of permissions.
  • ManagePosts.php -
  • ManageRegistration.php -
  • ManageScheduledTasks.php -
  • ManageSearch.php -
  • ManageSearchEngins.php -
  • MAnageServer.php -
  • ManageSettings.php -
  • ManageSmileys.php - Handles the managing of smileys.
  • Memberlist.php - contains the functions for displaying and searching in the members list.
  • MessageIndex.php - Shows the listing of topics in a board.
  • ModerationCenter.php -
  • Modlog.php - Controls the moderation log.
  • MoveTopic.php - Contains the functions required to move topics from one Board to another board.
  • News.php - Contains the files necessary to display news as an XML feed.
  • Notify.php - Controls the toggling of notifications.
  • PackageGet.php - Tool used by the Package Manager to retrieve package files.
  • Packages.php - The Package Manager of SMF.
  • PersonalMessage.php -
  • Poll.php - Contains the functions for voting, locking, removing and editing polls.
  • Post.php - Handles everything related to posting replies, new topics, quotes and modifications to existing posts. Also handles quoting posts by way of a popup.
  • PostModeration.php -
  • Printpage.php - File used to format a Topic to make it printer-friendly.
  • Profile-Actions.php -
  • Profile-Modify.php -
  • Profile-View.php -
  • Profile.php - Handles user profiles.
  • QueryString.php - Handles the query string, request variables and session management.
  • Recent.php - Finds and retrieves information about recently posted topics, messages, etc.
  • Register.php - Manages registrations.
  • Reminder.php - Used to send members password reminders.
  • RemoveTopic.php - Used to completely remove an entire topic.
  • RepairBoards.php - Used when searching for and repairing data errors or corruption.
  • Reports.php -
  • ScheduledTasks.php -
  • Search.php - Files used to search an SMF forum.
  • SearchAPI-Custom.php -
  • SearchAPI-Fulltext.php -
  • SearchAPI-Standard.php -
  • Security.php - Insures Forum security.
  • SendTopic.php - File that deals with sending topics to a friend.
  • SplitTopics.php - This file handles merging and splitting topics.
  • Stats.php - Provides a display for Forum statistics.
  • Subs-Admin.php -
  • Subs-Auth.php - Handles authentication, user handling, etc.
  • Subs-BoardIndex.php -
  • Subs-Boards.php - Handles marking boards and topics read, collapsing categories and quick moderation.
  • Subs-Calendar.php -
  • Subs-Category.php -
  • Subs-Charset.php -
  • Subs-Compat.php -
  • Subs-Db-mysql.php -
  • Subs-Db-postgresql.php -
  • Subs-Db-sqlite.php -
  • Subs-Editor.php -
  • Subs-Graphics.php - Handles all aspects of users' avatars.
  • Subs-List.php -
  • Subs-Membergroups.php -
  • Subs-Members.php -
  • Subs-MembersOnline.php -
  • Subs-Menu.php -
  • Subs-MessageIndex.php -
  • Subs-OpenID.php -
  • Subs-Package.php - Contains functions for handling .tar.gz and .zip files, as well as a simple XML parser to handle the XML package stuff. Not to mention a few functions to make file handling easier.
  • Subs-Post.php - This file contains those functions pertaining to posting and other such operations, including sending emails, IMs, blocking spam, preparsing posts, spell checking and the Post box.
  • Subs-Recent.php -
  • Subs-Sound.php -
  • Subs.php - Contains many of the general-use functions the Forum needs to work.
  • Subscriptions-PayPal.php -
  • Themes.php - Handles Theme administration.
  • ViewQuery.php - This file is concerned with viewing queries and is used for debugging.
  • Who.php - Handles the "Who's Online" list.
  • Xml.php -

Themes

In this directory are contained all the themes installed in the forum, one theme for each subdirectory.

  • index.php - Does not allow contents of the directory to be listed.