From b9965c5b8835d4024f09bc5d9b749889bf5f36d2 Mon Sep 17 00:00:00 2001 From: PargeLenis Date: Fri, 17 Nov 2023 10:16:55 +0100 Subject: [PATCH] [Eluna] Remove further tabs --- src/modules/Eluna/README.md | 12 +++--- src/modules/Eluna/docs/DOC_GEN.md | 2 +- .../Eluna/docs/ElunaDoc/static/main.js | 10 ++--- src/modules/Eluna/docs/INSTALL.md | 14 +++---- src/modules/Eluna/docs/MERGING.md | 6 +-- .../Eluna/extensions/StackTracePlus/README.md | 40 +++++++++---------- 6 files changed, 42 insertions(+), 42 deletions(-) diff --git a/src/modules/Eluna/README.md b/src/modules/Eluna/README.md index 8cd1a97a85..fc7b654a3a 100644 --- a/src/modules/Eluna/README.md +++ b/src/modules/Eluna/README.md @@ -3,7 +3,7 @@ ## About Eluna Lua Engine © is a lua engine embedded to World of Warcraft emulators. Eluna supports MaNGOS, CMaNGOS, TrinityCore and AzerothCore. -We are currently working hard to make Eluna better from inside and outside. +We are currently working hard to make Eluna better from inside and outside. If you are having trouble with installation or scripts, please feel free to open an issue. For documentation and reference see [Eluna API](http://elunaluaengine.github.io/) and [Lua reference manual](http://www.lua.org/manual/5.2/). @@ -37,13 +37,13 @@ Core sources and forks with required modifications for Eluna: [TrinityCore WotLK](https://github.com/ElunaLuaEngine/ElunaTrinityWotlk) [![automerge](https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/actions/workflows/auto-merge.yml) -[Official MaNGOS Zero with Eluna](https://github.com/mangoszero/server) -[Official MaNGOS One with Eluna](https://github.com/mangosone/server) +[Official MaNGOS Zero with Eluna](https://github.com/mangoszero/server) +[Official MaNGOS One with Eluna](https://github.com/mangosone/server) [Official MaNGOS Two with Eluna](https://github.com/mangostwo/server) -[Eluna cMaNGOS Classic](https://github.com/Niam5/Eluna-CMaNGOS-Classic) - maintained by [Niam5](https://github.com/Niam5) -[Eluna cMaNGOS TBC](https://github.com/Niam5/Eluna-CMaNGOS-TBC) - maintained by [Niam5](https://github.com/Niam5) -[Eluna cMaNGOS WoTLK](https://github.com/Niam5/Eluna-CMaNGOS-WotLK) - maintained by [Niam5](https://github.com/Niam5) +[Eluna cMaNGOS Classic](https://github.com/Niam5/Eluna-CMaNGOS-Classic) - maintained by [Niam5](https://github.com/Niam5) +[Eluna cMaNGOS TBC](https://github.com/Niam5/Eluna-CMaNGOS-TBC) - maintained by [Niam5](https://github.com/Niam5) +[Eluna cMaNGOS WoTLK](https://github.com/Niam5/Eluna-CMaNGOS-WotLK) - maintained by [Niam5](https://github.com/Niam5) [AzerothCore Eluna Module](https://github.com/azerothcore/mod-eluna) diff --git a/src/modules/Eluna/docs/DOC_GEN.md b/src/modules/Eluna/docs/DOC_GEN.md index 6acac22bbf..d1c1c3527d 100644 --- a/src/modules/Eluna/docs/DOC_GEN.md +++ b/src/modules/Eluna/docs/DOC_GEN.md @@ -1,5 +1,5 @@ # Documentation generation -Eluna uses a custom made documentation generator to create it's [web documentation](http://elunaluaengine.github.io/). +Eluna uses a custom made documentation generator to create it's [web documentation](http://elunaluaengine.github.io/). The generator is written in python by Patman. It works by parsing Eluna's source files for comments and then generates the HTML and javascript for the documentation based on them. This page guides you through generating the web documentation locally and explains the standards of the documentation comments for you to help us improve our documentation. To contribute with your documentation changes, create a [pull request](https://help.github.com/articles/using-pull-requests/) diff --git a/src/modules/Eluna/docs/ElunaDoc/static/main.js b/src/modules/Eluna/docs/ElunaDoc/static/main.js index cb3f4bfc94..84ee789c20 100644 --- a/src/modules/Eluna/docs/ElunaDoc/static/main.js +++ b/src/modules/Eluna/docs/ElunaDoc/static/main.js @@ -118,7 +118,7 @@ * A function to compute the Levenshtein distance between two strings * Licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported * Full License can be found at http://creativecommons.org/licenses/by-sa/3.0/legalcode - * This code is an unmodified version of the code written by Marco de Wit + * This code is an unmodified version of the code written by Marco de Wit * and was found at http://stackoverflow.com/a/18514751/745719 */ var levenshtein = (function() { @@ -224,7 +224,7 @@ }); } } else if ( - (lev_distance = levenshtein(searchWords[j], val)) <= + (lev_distance = levenshtein(searchWords[j], val)) <= MAX_LEV_DISTANCE) { if (typeFilter < 0 || typeFilter === searchIndex[j].ty) { results.push({ @@ -350,16 +350,16 @@ function validateResult(name, path, keys, parent) { for (var i=0; i < keys.length; ++i) { // each check is for validation so we negate the conditions and invalidate - if (!( + if (!( // check for an exact name match name.toLowerCase().indexOf(keys[i]) > -1 || // then an exact path match path.toLowerCase().indexOf(keys[i]) > -1 || // next if there is a parent, check for exact parent match - (parent !== undefined && + (parent !== undefined && parent.name.toLowerCase().indexOf(keys[i]) > -1) || // lastly check to see if the name was a levenshtein match - levenshtein(name.toLowerCase(), keys[i]) <= + levenshtein(name.toLowerCase(), keys[i]) <= MAX_LEV_DISTANCE)) { return false; } diff --git a/src/modules/Eluna/docs/INSTALL.md b/src/modules/Eluna/docs/INSTALL.md index 6affaacee1..da5eb41cc4 100644 --- a/src/modules/Eluna/docs/INSTALL.md +++ b/src/modules/Eluna/docs/INSTALL.md @@ -3,17 +3,17 @@ This page will help you get a cMaNGOS and a TrinityCore source with Eluna. If you are looking to get MaNGOS source with Eluna head over to [MaNGOS forum](http://getmangos.eu/) for the installation and updating instructions - however read this page also as it contains important information. -If you are having trouble with the installation or updating the core source, head over to our [support forum](../README.md#documentation). +If you are having trouble with the installation or updating the core source, head over to our [support forum](../README.md#documentation). If you are looking for a way to merge eluna with a fork of the official repositories see [merging](MERGING.md). ### Requirements and dependencies: -**Eluna uses `C++11` so you need a compiler that supports it.** -**Eluna can use ACE or BOOST for filesystem library.** +**Eluna uses `C++11` so you need a compiler that supports it.** +**Eluna can use ACE or BOOST for filesystem library.** Additionally see you desired core's documentation and installation instructions for it's requirements and dependencies. ### Installation 1. Open [git bash](http://git-scm.com/) and navigate to where you want the core source -2. Choose the git address of your desired core and patch below and clone the core with `git clone
`. +2. Choose the git address of your desired core and patch below and clone the core with `git clone
`. For example `git clone https://github.com/ElunaLuaEngine/ElunaTrinityWotlk.git` * TrinityCore WoTLK: `https://github.com/ElunaLuaEngine/ElunaTrinityWotlk.git` * cMaNGOS Classic: `https://github.com/ElunaLuaEngine/ElunaMangosClassic.git` @@ -33,10 +33,10 @@ After installing Eluna you should check out these: - [Eluna features](IMPL_DETAILS.md) ### Updating -Updating is essentially handled in the same manner as you would normally update the core and database. +Updating is essentially handled in the same manner as you would normally update the core and database. To get the newest core source code open `git bash` and navigate to your local source folder. -Then execute use `git pull` followed by `git submodule init` and `git submodule update`. -After updating the source you need to recompile the core normally. Simply use `CMake` if needed and compile. +Then execute use `git pull` followed by `git submodule init` and `git submodule update`. +After updating the source you need to recompile the core normally. Simply use `CMake` if needed and compile. To update the databases refer to the core's or database's official updating documents: * [TrinityCore](http://collab.kpsn.org/display/tc/Databases+Installation) * [cMaNGOS](https://github.com/cmangos/issues/wiki/Installation-Instructions) diff --git a/src/modules/Eluna/docs/MERGING.md b/src/modules/Eluna/docs/MERGING.md index 2e488e44e8..240d1fe01e 100644 --- a/src/modules/Eluna/docs/MERGING.md +++ b/src/modules/Eluna/docs/MERGING.md @@ -1,10 +1,10 @@ # Merging Eluna -Eluna can be added to various sources by applying the core changes required for Eluna to function. -Below you find the guides for merging Eluna with each core or a fork of it. +Eluna can be added to various sources by applying the core changes required for Eluna to function. +Below you find the guides for merging Eluna with each core or a fork of it. If you choose to merge you should be able to maintain and update yourself - we do not maintain your core. View Unofficial Merging below. We also do not fix any merging errors you may have, but you are free to ask about them on the [support forum](../README.md#documentation) and we may assist. -We recommend using the [installation guide](INSTALL.md) especially if you are not familiar with git and updating the code. +We recommend using the [installation guide](INSTALL.md) especially if you are not familiar with git and updating the code. It allows you to simply use `git pull` followed by `git submodule update` to update your source and we will handle the merging and maintenance with the official core source. Naturally you still need to handle updating the database as instructed by the core's wiki or instructions. ### Merging Eluna with MaNGOS diff --git a/src/modules/Eluna/extensions/StackTracePlus/README.md b/src/modules/Eluna/extensions/StackTracePlus/README.md index 8216333f40..8504868b35 100644 --- a/src/modules/Eluna/extensions/StackTracePlus/README.md +++ b/src/modules/Eluna/extensions/StackTracePlus/README.md @@ -9,10 +9,10 @@ function names when they're not available, etc, so, instead of lua5.1.exe: D:\trunk_git\sources\stacktraceplus\test\test.lua:10: attempt to concatenate a nil value stack traceback: - D:\trunk_git\sources\stacktraceplus\test\test.lua:10: in function - (tail call): ? - D:\trunk_git\sources\stacktraceplus\test\test.lua:15: in main chunk - [C]: ? + D:\trunk_git\sources\stacktraceplus\test\test.lua:10: in function + (tail call): ? + D:\trunk_git\sources\stacktraceplus\test\test.lua:15: in main chunk + [C]: ? you'll get @@ -21,13 +21,13 @@ you'll get =============== (2) C function 'function: 00A8F418' (3) Lua function 'g' at file 'D:\trunk_git\sources\stacktraceplus\test\test.lua:10' (best guess) - Local variables: - fun = table module - str = string: "hey" - tb = table: 027DCBE0 {dummy:1, blah:true, foo:bar} - (*temporary) = nil - (*temporary) = string: "text" - (*temporary) = string: "attempt to concatenate a nil value" + Local variables: + fun = table module + str = string: "hey" + tb = table: 027DCBE0 {dummy:1, blah:true, foo:bar} + (*temporary) = nil + (*temporary) = string: "text" + (*temporary) = string: "attempt to concatenate a nil value" (4) tail call (5) main chunk of file 'D:\trunk_git\sources\stacktraceplus\test\test.lua' at line 15 (6) C function 'function: 002CA480' @@ -42,13 +42,13 @@ local STP = require "StackTracePlus" debug.traceback = STP.stacktrace function test() - local s = "this is a string" - local n = 42 - local t = { foo = "bar" } - local co = coroutine - local cr = coroutine.create + local s = "this is a string" + local n = 42 + local t = { foo = "bar" } + local co = coroutine + local cr = coroutine.create - error("an error") + error("an error") end test() ``` @@ -80,15 +80,15 @@ local STP = require "StackTracePlus" debug.traceback = STP.stacktrace local my_table = { - f = function() end + f = function() end } function my_function() end function test(data, func) - local s = "this is a string" + local s = "this is a string" - error("an error") + error("an error") end STP.add_known_table(my_table, "A description for my_table")