MediaWiki皮肤Citizen安装与配置指南
1. 项目的目录结构及介绍
从GitHub仓库下载的MediaWiki皮肤Citizen的目录结构如下:
mediawiki-skins-Citizen/
├── resources/
│ ├── assets/
│ ├── i18n/
│ ├── images/
│ ├── js/
│ └── modules/
├── skin.json
└── Citizen.php
resources/
:包含皮肤的资源文件,如CSS、JavaScript、图像等。assets/
:存放静态资源文件。i18n/
:存放国际化文件。images/
:存放图像文件。js/
:存放JavaScript文件。modules/
:存放模块文件。
skin.json
:皮肤的配置文件。Citizen.php
:皮肤的主文件。
2. 项目的启动文件介绍
Citizen.php
是皮肤的主文件,负责加载和初始化皮肤的所有资源和配置。在MediaWiki的 LocalSettings.php
文件中,通过以下代码加载皮肤:
wfLoadSkin( 'Citizen' );
3. 项目的配置文件介绍
skin.json
是皮肤的配置文件,包含皮肤的各种设置和选项。以下是一些常见的配置项:
{
"name": "Citizen",
"author": "alistair3149, Octfx",
"url": "https://github.com/StarCitizenTools/mediawiki-skins-Citizen",
"descriptionmsg": "citizen-desc",
"license-name": "GPL-2.0-or-later",
"type": "skin",
"AutoloadClasses": {
"SkinCitizen": "Citizen.php"
},
"ResourceFileModulePaths": {
"localBasePath": "resources",
"remoteSkinPath": "Citizen/resources"
},
"MessagesDirs": {
"Citizen": [
"resources/i18n"
]
},
"config": {
"CitizenTheme": {
"value": "auto"
}
}
}
name
:皮肤的名称。author
:皮肤的作者。url
:皮肤的GitHub仓库地址。descriptionmsg
:皮肤的描述信息。license-name
:皮肤的许可证。type
:皮肤的类型。AutoloadClasses
:自动加载的类。ResourceFileModulePaths
:资源文件的路径。MessagesDirs
:国际化文件的路径。config
:皮肤的配置选项。
通过修改 skin.json
文件中的配置项,可以自定义皮肤的各种功能和样式。
安装步骤
- 下载皮肤文件并将其放置在
skins/
目录下。 - 在
LocalSettings.php
文件底部添加以下代码:
wfLoadSkin( 'Citizen' );
- 根据需要配置
skin.json
文件。 - 访问
Special:Version
页面,确认皮肤已成功安装。
通过以上步骤,您可以成功安装并配置MediaWiki皮肤Citizen。