From 32b06f7439d4dbaf80cdb2949c5eae96e9c1c29e Mon Sep 17 00:00:00 2001 From: Artem Vorotnikov Date: Tue, 11 Aug 2015 21:54:43 +0300 Subject: [PATCH] [Update] Change links to the new docs --- BUILDING.md | 2 +- CONTRIBUTING.md | 9 +-- bin/resources/scripts/races.as | 62 +++++++++----------- source/main/gfx/OgreSubsystem.cpp | 2 +- source/main/gui/OverlayWrapper.cpp | 2 +- source/main/main_sim/main.cpp | 2 +- source/main/physics/collision/Collisions.cpp | 2 +- 7 files changed, 39 insertions(+), 42 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 2a15cb55ca..b669ac3aca 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,5 +1,5 @@ # Building instructions -Please refer to http://www.rigsofrods.com/wiki/pages/Compiling_Sources +Please refer to https://rigsofrods.github.io/en/docs/index.html ## CMake options ##### Rigs of Rods core: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd7396516c..b0845157a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ e.g. screenshot of graphical glitch ### Setup * Fork, then clone the repository -* Set up your development environment, help may be found [here][compile] +* Set up your development environment, help may be found [here][docindex] * Make sure Rigs of Rods runs properly before doing any changes ### Applying changes @@ -60,11 +60,12 @@ e.g. screenshot of graphical glitch * At this point you're waiting on us. We may suggest changes, improvements or alternatives #### Additional links: +* [Documentation index][docindex] * [Developer Wiki Portal][devwiki] * [Doxygen documentation][doxy] -[compile]: http://www.rigsofrods.com/wiki/pages/Compiling_Sources -[style]: http://www.rigsofrods.com/wiki/pages/Coding_style -[commit]: http://www.rigsofrods.com/wiki/pages/Commit_style +[docindex]: https://rigsofrods.github.io/en/docs +[style]: https://rigsofrods.github.io/en/docs/coding-style +[commit]: https://rigsofrods.github.io/en/docs/commit-style [devwiki]: http://www.rigsofrods.com/wiki/pages/Developer_Wiki_Portal [doxy]: http://ror.ezzg.be/docs/ diff --git a/bin/resources/scripts/races.as b/bin/resources/scripts/races.as index 8ff0ffec67..00e1db8ab1 100644 --- a/bin/resources/scripts/races.as +++ b/bin/resources/scripts/races.as @@ -1,36 +1,32 @@ -/* -Hi, - -You've found your way to the race system of Rigs of Rods. - -If you are looking for more information on how to use this -class or what arguments should be given to certain functions, -please visit http://docs.rigsofrods.com/ - -If you are looking for examples on how to use this class, -please look at the scripting files of other terrains or -search the forum. - -If you have questions that cannot be answerred using the -methods mentioned above, then please ask your question in -the scripting section of the Rigs of Rods forum: -http://www.rigsofrods.com/forums/167-Scripting - -This class was designed to be as simple as possible for -normal users, while being as flexible as possible for -advanced users. -If you're here because this class doesn't provide the -functionality that you need for your terrain, then try -to improve the class and submit your additions using -the issue tracker of Rigs of Rods. -http://redmine.rigsofrods.com - -Don't forget to increase the version numbers after every -edit! (racesManager::raceManagerVersion and -raceBuilder::raceBuilderVersion) - --- neorej16 -*/ +// Hi, +// +// You've found your way to the race system of Rigs of Rods. +// +// If you are looking for more information on how to use this +// class or what arguments should be given to certain functions, +// please visit https://rigsofrods.github.io/en/docs/ +// +// If you are looking for examples on how to use this class, +// please look at the scripting files of other terrains or +// search the forum. +// +// If you have questions that cannot be answerred using the +// methods mentioned above, then please ask your question in +// the scripting section of the Rigs of Rods forum: +// http://www.rigsofrods.com/forums/167-Scripting +// +// This class was designed to be as simple as possible for +// normal users, while being as flexible as possible for +// advanced users. +// If you're here because this class doesn't provide the +// functionality that you need for your terrain, then try +// to improve the class and submit your additions using +// the issue tracker of Rigs of Rods. +// http://github.com/RigsOfRods/rigs-of-rods/issues +// +// Don't forget to increase the version numbers after every +// edit! (racesManager::raceManagerVersion and +// raceBuilder::raceBuilderVersion) // Define a function signature for the callback pointers funcdef void RACE_EVENT_CALLBACK(dictionary@); diff --git a/source/main/gfx/OgreSubsystem.cpp b/source/main/gfx/OgreSubsystem.cpp index 846aa144b7..fe2d73895a 100644 --- a/source/main/gfx/OgreSubsystem.cpp +++ b/source/main/gfx/OgreSubsystem.cpp @@ -154,7 +154,7 @@ bool OgreSubsystem::StartOgre(Ogre::String const & name, Ogre::String const & hw } catch(Ogre::Exception& e) { - Ogre::String url = "http://wiki.rigsofrods.com/index.php?title=Error_" + TOSTRING(e.getNumber())+"#"+e.getSource(); + Ogre::String url = "https://rigsofrods.github.io/en/docs/errors/index.html#" + TOSTRING(e.getNumber()); ErrorUtils::ShowOgreWebError(_L("A fatal exception has occured!"), ANSI_TO_UTF(e.getFullDescription()), ANSI_TO_UTF(url)); ErrorUtils::ShowStoredOgreWebErrors(); exit(1); diff --git a/source/main/gui/OverlayWrapper.cpp b/source/main/gui/OverlayWrapper.cpp index 2b0e4d8b59..affe327d16 100644 --- a/source/main/gui/OverlayWrapper.cpp +++ b/source/main/gui/OverlayWrapper.cpp @@ -141,7 +141,7 @@ int OverlayWrapper::init() directionArrowText = (TextAreaOverlayElement*)loadOverlayElement("tracks/DirectionArrow/Text"); } catch(...) { - String url = "http://wiki.rigsofrods.com/index.php?title=Error_Resources_Not_Found"; + String url = "https://rigsofrods.github.io/en/docs/errors/index.html#Error_Resources_Not_Found"; ErrorUtils::ShowOgreWebError("Resources not found!", "please ensure that your installation is complete and the resources are installed properly. If this error persists please re-install RoR.", url); } directionArrowDistance = (TextAreaOverlayElement*)loadOverlayElement("tracks/DirectionArrow/Distance"); diff --git a/source/main/main_sim/main.cpp b/source/main/main_sim/main.cpp index c21cacf610..357200e79d 100644 --- a/source/main/main_sim/main.cpp +++ b/source/main/main_sim/main.cpp @@ -331,7 +331,7 @@ int main(int argc, char *argv[]) } catch (Ogre::Exception& e) { - String url = "http://wiki.rigsofrods.com/index.php?title=Error_" + TOSTRING(e.getNumber())+"#"+e.getSource(); + String url = "https://rigsofrods.github.io/en/docs/errors/index.html#" + TOSTRING(e.getNumber()); ErrorUtils::ShowOgreWebError(_L("An exception has occured!"), e.getFullDescription(), url); } catch (std::runtime_error& e) diff --git a/source/main/physics/collision/Collisions.cpp b/source/main/physics/collision/Collisions.cpp index 0406ef3eaa..7053e7ab71 100644 --- a/source/main/physics/collision/Collisions.cpp +++ b/source/main/physics/collision/Collisions.cpp @@ -231,7 +231,7 @@ int Collisions::loadGroundModelsConfigFile(Ogre::String filename) if (this->collision_version != LATEST_GROUND_MODEL_VERSION) { // message box - String url = "http://wiki.rigsofrods.com/index.php?title=Error_Old_ground_model#"+TOSTRING(this->collision_version)+"to"+TOSTRING(LATEST_GROUND_MODEL_VERSION); + String url = "https://rigsofrods.github.io/en/docs/errors/index.html#Error_Old_ground_model"; ErrorUtils::ShowOgreWebError(_L("Configuration error"), _L("Your ground configuration is too old, please copy skeleton/config/ground_models.cfg to My Documents/Rigs of Rods/config"), url); ErrorUtils::ShowStoredOgreWebErrors(); exit(124);