Fix links and some formatting in patchers pages

HerculesWS · Apr 26, 2024 · 5a477f3 · 5a477f3
1 parent 244b272
commit 5a477f3
Show file tree

Hide file tree

Showing 5 changed files with 271 additions and 264 deletions.
diff --git a/docs/client/patchers/index.md b/docs/client/patchers/index.md
@@ -1,9 +1,5 @@
 Auto-patchers are a way for players to stay up-to-date with your latest client-side files. Most of them can update data
-folders and [GRF's](GRF "wikilink"). Selected patchers may support other formats as well.
+folders and [GRF's](../grf.md). Selected patchers may support other formats as well.
 
 Below is a list of guides to setup each patcher. To add an article to this category add following at the end of the
 article:
-
-`[[Category:Patchers]]`
-
-[Category:Client_Configuration](Category:Client_Configuration "wikilink")
diff --git a/docs/client/patchers/kpatcher.md b/docs/client/patchers/kpatcher.md
@@ -1,6 +1,8 @@
+# KPatcher
+
 **KPatcher** is a Ragnarok Online auto-patcher, written in Embarcadero C++ Builder XE2. It was originally developed in
-the Russian eAthena community[1](http://www.eathena.ws/board/index.php?showtopic=216716), but later released as
-multi-language version[2](http://www.eathena.ws/board/index.php?showtopic=247878), currently supporting Russian,
+the Russian eAthena community ([link](http://www.eathena.ws/board/index.php?showtopic=216716)), but later released as
+multi-language version ([link](http://www.eathena.ws/board/index.php?showtopic=247878)), currently supporting Russian,
 English, Spanish, Japanese, Chinese, Portuguese and Indonesian, with further languages being planned. It consists of the
 patcher binary itself and a tool for creating configuration. It works on Windows 2000, Windows XP and higher.
 
@@ -75,48 +77,48 @@ The patch list is a simple text file, which uses one line for each patch. Patche
 beginning with // are considered a comment and ignored, which can also be used for disabling patches. Following patch
 types exist:
 
-- **PAU**  
+- **PAU**
   Specifies patch for updating the patcher.
       PAU:CRC:patcher.upd
 
   CRC is the checksum of the new patcher executable **patcher.upd**. If the CRC of the current patcher differs, update
   of the patcher will occur. Might appear everywhere in the patch list, but preferably at the beginning.
-- **GRF**  
+- **GRF**
   Specifies a patch, which will be applied to a GRF archive. This type has two forms; the first applies the patch to the
   main archive as specified in settings, the other applies the patch to the GRF archive specified before the type.
       PID:GRF:2010-09-30palettefix.gpf
 
       PID:adata.grf:GRF:2010-09-30palettefix.gpf
-- **ARCH**  
+- **ARCH**
   Specifies, that the patch is a ZIP archive, which will be extracted into the folder, where the patcher resides,
   including the folder structure stored inside the archive.
       PID:ARCH:newclient.zip
-- **GDF**  
+- **GDF**
   Specifies a file, to be removed from the main GRF archive.
       PID:GDF:data\clientinfo.xml
 
   This type also accepts [regular expressions](http://en.wikipedia.org/wiki/Regular_expression), such as deleting all
   palette files (\*.pal), would be:
 
       PID:GDF:^.+\.pal$
-- **CDF**  
+- **CDF**
   Specifies a local file to be deleted from the folder, where the patcher resides.
       PID:CDF:dinput.dll
 
 #### Example
 
-`PAU:CRC:patcher.upd`  
-`//1:GRF:pal.gpf`  
-`2:GRF:rdata.grf`  
-`3:ARCH:lib.zip`  
-`//4:ARCH:data.zip`  
-`5:GDF:data\clientinfo.xml`  
-`6:CDF:dinput.dll`  
-`7:name.grf:GRF:patch.grf`
+```
+PAU:CRC:patcher.upd
+//1:GRF:pal.gpf
+2:GRF:rdata.grf
+3:ARCH:lib.zip
+//4:ARCH:data.zip
+5:GDF:data\clientinfo.xml
+6:CDF:dinput.dll
+7:name.grf:GRF:patch.grf
+```
 
 ## External Links
 
 - [Official KPatcher Topic (English)](http://www.eathena.ws/board/index.php?showtopic=247878)
 - [Official KPatcher Topic (Russian)](http://www.eathena.ws/board/index.php?showtopic=216716)
-
-[Category:Patchers](Category:Patchers "wikilink")
diff --git a/docs/client/patchers/neoncube.md b/docs/client/patchers/neoncube.md
@@ -1,6 +1,8 @@
-To use this guide you must have a basic understanding of [Hercules](Hercules "wikilink"), a [Web
-Server](https://en.wikipedia.org/wiki/Web_Server) and how to edit, upload and manipulate files. You also need to be versatile in
-making [GRF](GRF "wikilink") and [RAR](https://en.wikipedia.org/wiki/RAR_(file_format)) files.
+# NeonCube
+
+To use this guide you must have a basic understanding of [Hercules](../../about/index.md),
+a [Web Server](https://en.wikipedia.org/wiki/Web_Server) and how to edit, upload and manipulate files. You also need to be versatile in
+making [GRF](../grf.md) and [RAR](https://en.wikipedia.org/wiki/RAR_(file_format)) files.
 
 ## Programs you need
 
@@ -40,22 +42,23 @@ There are client and server files that need to be properly setup to work togethe
 8.  Read the examples then edit the values (all lines starting with **;** are comments and can be removed if you want).
 
 Sample **neoncube.ini**
-
-<tt>`[server]`  
-`server_name = YourRO`  
-`notice_url = yourro.com/patcher/index.html`  
-`patch_site = yourro.com`  
-`patch_port = 80`  
-`patch_list = /patcher/patchlist.txt`  
-`patch_folder = /patcher/patch/`  
-`executable = YourRO.exe`  
-`registration_link = http://yourro.com/cp/`  
-`skin = skin_rag`  
-`grf_file = yourro.grf`  
-`Backup_GRF = 1`  
-`startup_option = 3`  
-`[general]`  
-`archive_passphrase =`</tt>
+```ini
+[server]
+server_name = YourRO
+notice_url = yourro.com/patcher/index.html
+patch_site = yourro.com
+patch_port = 80
+patch_list = /patcher/patchlist.txt
+patch_folder = /patcher/patch/
+executable = YourRO.exe
+registration_link = http://yourro.com/cp/
+skin = skin_rag
+grf_file = yourro.grf
+Backup_GRF = 1
+startup_option = 3
+[general]
+archive_passphrase =
+```
 
 NOTES:
 
@@ -69,43 +72,47 @@ this guide.
 
 #### /patcher/index.html
 
-This is the News Page that the patcher will display (supports HTML, PHP, ASP, XML)  
+This is the News Page that the patcher will display (supports HTML, PHP, ASP, XML)
 Create this file on the web server you defined with **notice_url**
 
 #### /patcher/patch/
 
-This is the folder where you will put all the patches you create.  
+This is the folder where you will put all the patches you create.
 Create this folder on the web server you defined with *patch_site*'
 
 #### /patcher/patchlist.txt
 
 This is the file that lists your patches and tells the NeonCube patcher (client) what to download and where to patch
-it.  
+it.
 Create this file on the web server you defined with **patch_site**
 
 Format:
 
-`patch#`<TAB>`destination`<TAB>`patch_name`
+```
+patch#<TAB>destination<TAB>patch_name
+```
 
-patch#  
+patch#
 start with 1, and increment for each new patch
 
-destination  
+destination
 GRF will patch the grf, FLD will extract to folder
 
-patch_name  
+patch_name
 the name of the patch (including file extension, of course)
 
 Sample **patchlist.txt** (take note of the TABs. Comments are allowed)
 
-`//this will extract patch1.gpf into the data folder`  
-`1 FLD patch1.gpf`  
-`//here, patch2.gpf will be mergegd with grf_file`  
-`2 GRF patch2.gpf`  
-`//You can also delete files from the data folder.`  
-`3 FLD data\filenametodelete.xml*`  
-`//Deleting files inside a GRF archive is still supported`  
-`4 GRF data\i_will_delete_you.txt*`
+```
+//this will extract patch1.gpf into the data folder
+1 FLD patch1.gpf
+//here, patch2.gpf will be mergegd with grf_file
+2 GRF patch2.gpf
+//You can also delete files from the data folder.
+3 FLD data\filenametodelete.xml*
+//Deleting files inside a GRF archive is still supported
+4 GRF data\i_will_delete_you.txt*
+```
 
 ## Making a .GPF patch
 
@@ -159,11 +166,9 @@ you have additional text/formatted/unformatted characters before your list actua
 
 ## See Also
 
-- [GRF](GRF "wikilink")
+- [GRF](../grf.md)
 
 ## External Links
 
 - [Official Neoncube Homepage](http://patch.neon-cube.net/)
 - [Official Neoncube Board Topic](http://www.eathena.ws/board/index.php?showtopic=130342)
-
-[Category:Patchers](Category:Patchers "wikilink")
diff --git a/docs/client/patchers/thor-patcher.md b/docs/client/patchers/thor-patcher.md
@@ -1,6 +1,8 @@
-[Thor Patcher](Thor_Patcher "wikilink") is designed with the client-side config file embed *inside* the patcher itself.
-Since it uses no extra DLLs, you may distribute 1 file to your players. This guide will not discuss how to setup a [Web
-Server](https://en.wikipedia.org/wiki/Web_Server).
+# Thor Patcher
+
+Thor Patcher is designed with the client-side config file embed *inside* the patcher itself.
+Since it uses no extra DLLs, you may distribute 1 file to your players. This guide will not discuss how to
+setup a [Web Server](https://en.wikipedia.org/wiki/Web_Server).
 
 # Features
 
@@ -61,10 +63,10 @@ A Thor Patcher skin is divided into following parts:
     - Custom Buttons:
 
       
-    see [guide](#Custom_Buttons "wikilink")
+    see [guide](#custom-buttons)
 3.  **Custom Notice Box**:
 
-    see [guide](#Custom_Notice_Box "wikilink")
+    see [guide](#custom-notice-box)
 4.  **Progressbar** (*Shows the patching progress*)
     - Supported formats when use image based progress bar
       - bmp
@@ -441,33 +443,31 @@ If for example, you would like a feed exported from your "News and Announcements
 could easily include a small snippet of php on the page to echo out a few of your latest topics. For example, the
 following code would be sufficient to output the latest 5 topics in your notice.php:
 
+```html+php
 <?php
- $content = file_get_contents('http://mywebsite.com/forums/index.php?/rss/forums/1-announcements/');
- if($content) {
- 	$i = 0;
- 	$xml = new SimpleXmlElement($content);
- 	$newsAmount = (int)5;
- }
- ?>
- &#10; <?php if(isset($xml) && isset($xml->channel)): ?>
- 	<?php foreach($xml->channel->item as $rssItem): ?>
- 		<?php $i++; if($i <= $newsAmount): ?>
- 		<nowiki><div style="padding-left: 20px;"></nowiki>
- 			<nowiki><span><a href="<?php echo $rssItem->link ?>"><?php echo $rssItem->title ?></a></span></nowiki>
- 			<nowiki><p></nowiki>
- 				<?php echo $rssItem->description ?>
- 				<?php echo date('M j, Y', strtotime($rssItem->pubDate)) ?>
- 			<nowiki>
-
-</nowiki>
-
-`   <br />`  
-`  </div>`  
-`  `
-
-<?php endif ?>
-<?php endforeach ?>
+	$content = file_get_contents('http://mywebsite.com/forums/index.php?/rss/forums/1-announcements/');
+	if ($content) {
+		$i = 0;
+		$xml = new SimpleXmlElement($content);
+		$newsAmount = (int)5;
+	}
+?>
+
+<?php if(isset($xml) && isset($xml->channel)): ?>
+	<?php foreach($xml->channel->item as $rssItem): ?>
+		<?php $i++; if($i <= $newsAmount): ?>
+		<div style="padding-left: 20px;">
+			<span><a href="<?php echo $rssItem->link ?>"><?php echo $rssItem->title ?></a></span>
+			<p>
+				<?php echo $rssItem->description ?>
+				<?php echo date('M j, Y', strtotime($rssItem->pubDate)) ?>
+			</p>
+			<br />
+		</div>
+		<?php endif ?>
+	<?php endforeach ?>
 <?php endif ?>
+```
 
 You will need to ensure that the forum topics you are exporting have an RSS feed being output. If not (in the case of
 IPB especially) you will need to login to the admin panel and create the export feed manually.
@@ -477,19 +477,19 @@ IPB especially) you will need to login to the admin panel and create the export
 By default, the file containing a list of your uploaded patches is called plist.txt, and is defined in the main.ini file
 situated on your web host. Patches should be defined in sequential number like so:
 
-`...`  
-`15 20131106_newclient.thor`  
-`16 20131106_GM_Fix.thor`  
-`17 20131106_Wings.thor`  
-`... etc`
+```
+...
+15 20131106_newclient.thor
+16 20131106_GM_Fix.thor
+17 20131106_Wings.thor
+... etc
+```
 
 # See Also
 
-- [GRF](GRF "wikilink")
+- [GRF](../grf.md)
 
 ## External Links
 
 - [Official Thor Patcher Homepage](http://thor.aeomin.net/)
 - [Official Thor Patcher Thread](http://www.eathena.ws/board/index.php?showtopic=171632)
-
-[Category:Patchers](Category:Patchers "wikilink")