Skip to content

Commit

Permalink
meta: Use GitHub as canonical repo
Browse files Browse the repository at this point in the history
- GitHub is the canonical repo.
- Replace deprecated license string `GPL-3.0+` with `GPL-3.0-or-later`.
- Fix some markdownlint errors.

Signed-off-by: Yongmin Hong <[email protected]>
  • Loading branch information
revi committed Dec 30, 2024
1 parent 441bb7b commit 3436b96
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 4 deletions.
6 changes: 6 additions & 0 deletions .github/README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ Our canonical source is [GitHub.com](https://github.com/librewiki/liberty-skin),
Security vulnerability should be reported using email (dev (골뱅이!) librewiki.net) (replace (Korean text) with @).

## Installation

* Unzip to the MediaWiki Skins folder or perform a git clone. The name of the unzipped folder should be `Liberty`.
* Add `wfLoadSkin( 'Liberty' );` to your LocalSettings.php file.

## Configurations

Please set these variables in the LocalSettings.php file.

| Name | Description | Example Variable | Default Variable |
Expand All @@ -32,6 +34,7 @@ Please set these variables in the LocalSettings.php file.
| `$wgLibertyLiveRCTalkNamespaces` | Namespaces for the second tab in 'Recent Changes' | `[NS_TALK, NS_USER_TALK, NS_PROJECT_TALK, NS_FILE_TALK, NS_MEDIAWIKI_TALK, NS_TEMPLATE_TALK, NS_HELP_TALK, NS_CATEGORY_TALK]` | `[NS_TALK, NS_USER_TALK, NS_PROJECT_TALK, NS_FILE_TALK, NS_MEDIAWIKI_TALK, NS_TEMPLATE_TALK, NS_HELP_TALK, NS_CATEGORY_TALK]` |

## Navbar

Please fill out `MediaWiki:Liberty-Navbar` article in the following format.

* First-Level menu:
Expand All @@ -40,7 +43,9 @@ Please fill out `MediaWiki:Liberty-Navbar` article in the following format.
* `** icon=icon | display=display text | title=hover text | link=link | access=shortcut key | class=custom HTML classes | group=required user group | right=required user right`
* Third-Level menu:
* `*** icon=icon | display=display text | title=hover text | link=link | access=shortcut key | class=custom HTML classes | group=required user group | right=required user right`

---

* All values are optional, but at least one of `icon` or `display` must be set.
* If `title` is not set, `display` is used instead.
* If you don't want to set some parameters, you can skip them. As an example, if you don't want to set an icon, skip `icon=...`.
Expand All @@ -52,6 +57,7 @@ Please fill out `MediaWiki:Liberty-Navbar` article in the following format.
You can see an example on [LibreWiki](https://librewiki.net/wiki/MediaWiki:Liberty-Navbar).

## Rights

Four rights have been added to this to implement ad differentiation by user rights. if $wgLibertyAdGroup is set to 'differ', add user preferences to remove ads.
* blockads-header : User can remove header ads.
* blockads-right : User can remove header ads.
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@
보안 취약점은 이메일 (dev(골뱅이!)librewiki.net) 로 보고해 주세요.

## 설치

* 미디어위키 Skins 폴더에 압축을 풀거나 git clone을 수행하세요. 압축해제된 폴더의 이름은 `Liberty` 이어야 합니다.
* LocalSettings.php 파일에 `wfLoadSkin( 'Liberty' );` 를 추가해 주세요.

## 설정

LocalSettings.php 파일에 아래와 같이 작성해주세요.

| 이름 | 설명 | 예시 값 | 기본 값 |
Expand All @@ -34,6 +36,7 @@ LocalSettings.php 파일에 아래와 같이 작성해주세요.
| `$wgLibertyLiveRCTalkNamespaces` | 사이드바 최근 변경 오른쪽 탭에 보여질 네임스페이스 목록 | `[NS_TALK, NS_USER_TALK, NS_PROJECT_TALK, NS_FILE_TALK, NS_MEDIAWIKI_TALK, NS_TEMPLATE_TALK, NS_HELP_TALK, NS_CATEGORY_TALK]` | `[NS_TALK, NS_USER_TALK, NS_PROJECT_TALK, NS_FILE_TALK, NS_MEDIAWIKI_TALK, NS_TEMPLATE_TALK, NS_HELP_TALK, NS_CATEGORY_TALK]` |

## 상단바

다음과 같은 형식을 따라서 `미디어위키:Liberty-Navbar` 문서에 작성해주세요.

* 최상단 메뉴:
Expand All @@ -42,7 +45,9 @@ LocalSettings.php 파일에 아래와 같이 작성해주세요.
* `** icon=아이콘 | display=표시 내용 | title=Hover 문구 | link=클릭시 링크 | access=단축키 | class=커스텀 HTML 클래스 | group=필요 그룹 | right=필요 권한`
* 최하위 메뉴:
* `*** icon=아이콘 | display=표시 내용 | title=Hover 문구 | link=클릭시 링크 | access=단축키 | class=커스텀 HTML 클래스 | group=필요 그룹 | right=필요 권한`

---

* 모든 내용은 선택이나, `icon``display` 중 적어도 하나는 설정되어 있어야 합니다.
* 설정하지 않을 내용은 적지 않으면 됩니다. 예를 들어, 아이콘을 설정하지 않으려면 `icon=...`을 생략하면 됩니다.
* `title`이 설정되어 있지 않다면 `display`로 자동 설정 됩니다.
Expand All @@ -54,7 +59,9 @@ LocalSettings.php 파일에 아래와 같이 작성해주세요.
예시는 [리브레 위키](https://librewiki.net/wiki/MediaWiki:Liberty-Navbar)에서 확인할 수 있습니다.

## 권한

권한별 광고 차등화를 구현하기 위해 아래와 같이 네 가지 권한이 추가됩니다. 만약 $wgLibertyAdGroup이 'differ'로 설정되어 있다면 아래 권한에 따라 환경설정에 광고 커스터마이징 옵션이 나타납니다.

* blockads-header : 헤더 광고를 없앨 수 있습니다.
* blockads-right : 우측 광고를 없앨 수 있습니다.
* blockads-belowarticle : 글 하단 광고를 없앨 수 있습니다.
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "librewiki/liberty-mw-skin",
"version": "1.13.8",
"description": "Liberty MediaWiki Skin",
"license": "GPL-3.0+",
"license": "GPL-3.0-or-later",
"require-dev": {
"mediawiki/mediawiki-codesniffer": ">=0.9.0"
},
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
},
"repository": {
"type": "git",
"url": "git+ssh://git@gitlab.com/librewiki/Liberty-MW-Skin.git"
"url": "git+ssh://git@github.com/librewiki/liberty-skin.git"
},
"author": "SEE AUTHOR IN <AUTHORS.txt>",
"license": "GPL-3.0-or-later",
"bugs": {
"url": "https://gitlab.com/librewiki/Liberty-MW-Skin/issues"
"url": "https://github.com/librewiki/liberty-skin/issues"
},
"homepage": "https://gitlab.com/librewiki/Liberty-MW-Skin#README",
"homepage": "https://github.com/librewiki/liberty-skin#README",
"devDependencies": {
"eslint": "^4.1.0",
"eslint-config-wikimedia": "^0.4.0",
Expand Down

0 comments on commit 3436b96

Please sign in to comment.