Rename multi-worded samples to use underscore

bitmapfont -> bitmap_font
customlog -> custom_log
databinding -> data_binding
loaddocument -> load_document
treeview -> tree_view
luainvaders -> lua_invaders

Backends/RmlUi_Renderer_VK.cpp

@@ -193,7 +193,7 @@ void RenderInterface_VK::RenderGeometry(Rml::CompiledGeometryHandle geometry, Rm
 	{
 		// it means our state is dirty and we need to update data, but it is not right in terms of architecture, for real better experience would
 		// be great to free all "compiled" geometries and "re-build" them in one general way, but here I got only three callings for
-		// font-face-layer textures (loaddocument example) and that shit. So better to think how to make it right, if it is fine okay, if it is
+		// font-face-layer textures (load_document example) and that shit. So better to think how to make it right, if it is fine okay, if it is
 		// not okay and like we really expect that ReleaseCompiledGeometry for all objects that needs to be rebuilt so better to implement that,
 		// but still it is a big architectural thing (or at least you need to do something big commits here to implement a such feature), so my
 		// implementation doesn't break anything what we had, but still it looks strange. If I get callings for releasing maybe I need to use it

CMakePresets.json

@@ -21,7 +21,7 @@
 		},
 		{
 			"name": "standalone",
-			"description": "Build the library completely without any dependencies, features the `bitmapfont` sample.",
+			"description": "Build the library completely without any dependencies, features the `bitmap_font` sample.",
 			"cacheVariables": {
 				"RMLUI_SAMPLES": true,
 				"RMLUI_FONT_ENGINE": "none",

Samples/CMakeLists.txt

@@ -25,7 +25,7 @@ if(RMLUI_SAMPLES)
 		add_subdirectory("tutorial")
 	endif()
 	if(RMLUI_FONT_ENGINE_ENABLED AND RMLUI_LUA_BINDINGS)
-		add_subdirectory("luainvaders")
+		add_subdirectory("lua_invaders")
 	endif()
 
 	install(DIRECTORY assets shell

Samples/basic/CMakeLists.txt

@@ -1,18 +1,18 @@
 # The following sample does not require any default font engine.
-add_subdirectory("bitmapfont")
+add_subdirectory("bitmap_font")
 
 # Only enable the remaining samples if a default font engine is selected.
 if(RMLUI_FONT_ENGINE_ENABLED)
 	add_subdirectory("animation")
 	add_subdirectory("benchmark")
-	add_subdirectory("customlog")
-	add_subdirectory("databinding")
+	add_subdirectory("custom_log")
+	add_subdirectory("data_binding")
 	add_subdirectory("demo")
 	add_subdirectory("drag")
 	add_subdirectory("effects")
-	add_subdirectory("loaddocument")
+	add_subdirectory("load_document")
 	add_subdirectory("transform")
-	add_subdirectory("treeview")
+	add_subdirectory("tree_view")
 
 	if(RMLUI_HARFBUZZ_SAMPLE)
 		add_subdirectory("harfbuzz")

Samples/basic/bitmapfont/CMakeLists.txt → Samples/basic/bitmap_font/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(SAMPLE_NAME "bitmapfont")
+set(SAMPLE_NAME "bitmap_font")
 set(TARGET_NAME "${RMLUI_SAMPLE_PREFIX}${SAMPLE_NAME}")
 
 add_executable(${TARGET_NAME} WIN32

Samples/basic/bitmapfont/src/main.cpp → Samples/basic/bitmap_font/src/main.cpp

@@ -86,7 +86,7 @@ int main(int /*argc*/, char** /*argv*/)
 	Rml::Debugger::Initialise(context);
 
 	// Load bitmap font
-	if (!Rml::LoadFontFace("basic/bitmapfont/data/Comfortaa_Regular_22.fnt"))
+	if (!Rml::LoadFontFace("basic/bitmap_font/data/Comfortaa_Regular_22.fnt"))
 	{
 		Rml::Shutdown();
 		Backend::Shutdown();
@@ -95,7 +95,7 @@ int main(int /*argc*/, char** /*argv*/)
 	}
 
 	// Load and show the demo document.
-	if (Rml::ElementDocument* document = context->LoadDocument("basic/bitmapfont/data/bitmapfont.rml"))
+	if (Rml::ElementDocument* document = context->LoadDocument("basic/bitmap_font/data/bitmap_font.rml"))
 	{
 		if (auto el = document->GetElementById("title"))
 			el->SetInnerRML("Bitmap font");

Samples/basic/customlog/CMakeLists.txt → Samples/basic/custom_log/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(SAMPLE_NAME "customlog")
+set(SAMPLE_NAME "custom_log")
 set(TARGET_NAME "${RMLUI_SAMPLE_PREFIX}${SAMPLE_NAME}")
 
 add_executable(${TARGET_NAME} WIN32

Samples/basic/loaddocument/CMakeLists.txt → Samples/basic/data_binding/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(SAMPLE_NAME "loaddocument")
+set(SAMPLE_NAME "data_binding")
 set(TARGET_NAME "${RMLUI_SAMPLE_PREFIX}${SAMPLE_NAME}")
 
 add_executable(${TARGET_NAME} WIN32

Samples/basic/databinding/src/main.cpp → Samples/basic/data_binding/src/main.cpp

@@ -408,7 +408,7 @@ class DemoWindow : public Rml::EventListener {
 public:
 	DemoWindow(const Rml::String& title, Rml::Context* context)
 	{
-		document = context->LoadDocument("basic/databinding/data/databinding.rml");
+		document = context->LoadDocument("basic/data_binding/data/data_binding.rml");
 		if (document)
 		{
 			document->GetElementById("title")->SetInnerRML(title);

Samples/basic/databinding/CMakeLists.txt → Samples/basic/load_document/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(SAMPLE_NAME "databinding")
+set(SAMPLE_NAME "load_document")
 set(TARGET_NAME "${RMLUI_SAMPLE_PREFIX}${SAMPLE_NAME}")
 
 add_executable(${TARGET_NAME} WIN32

Samples/basic/treeview/CMakeLists.txt → Samples/basic/tree_view/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(SAMPLE_NAME "treeview")
+set(SAMPLE_NAME "tree_view")
 set(TARGET_NAME "${RMLUI_SAMPLE_PREFIX}${SAMPLE_NAME}")
 
 add_executable(${TARGET_NAME} WIN32

Samples/basic/treeview/src/main.cpp → Samples/basic/tree_view/src/main.cpp

@@ -79,7 +79,7 @@ int main(int /*argc*/, char** /*argv*/)
 	FileBrowser::Initialise(context, root);
 
 	// Load and show the demo document.
-	Rml::ElementDocument* document = context->LoadDocument("basic/treeview/data/treeview.rml");
+	Rml::ElementDocument* document = context->LoadDocument("basic/tree_view/data/tree_view.rml");
 	if (document)
 	{
 		document->GetElementById("title")->SetInnerRML(document->GetTitle());

Samples/luainvaders/CMakeLists.txt → Samples/lua_invaders/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(SAMPLE_NAME "luainvaders")
+set(SAMPLE_NAME "lua_invaders")
 set(TARGET_NAME "${RMLUI_SAMPLE_PREFIX}${SAMPLE_NAME}")
 
 add_executable(${TARGET_NAME} WIN32

Samples/luainvaders/data/window.rml → Samples/lua_invaders/data/window.rml

@@ -9,7 +9,7 @@ function Window.OnWindowLoad(document)
 end
 
 function Window.LoadMenu(name,document)
-	local doc = document.context:LoadDocument('luainvaders/data/' .. name .. '.rml')
+	local doc = document.context:LoadDocument('lua_invaders/data/' .. name .. '.rml')
 	if doc then
 		doc:Show()
 		document:Close()
@@ -18,7 +18,7 @@ function Window.LoadMenu(name,document)
 end
 
 function Window.OpenDocument(name,document)
-	local doc = document.context:LoadDocument('luainvaders/data/' .. name .. '.rml')
+	local doc = document.context:LoadDocument('lua_invaders/data/' .. name .. '.rml')
 	if doc then
 		doc:Show()
 	end

Samples/lua_invaders/lua/start.lua

@@ -0,0 +1,7 @@
+function Startup()
+	maincontext = rmlui.contexts["main"]
+	maincontext:LoadDocument("lua_invaders/data/background.rml"):Show()
+	maincontext:LoadDocument("lua_invaders/data/main_menu.rml"):Show()
+end
+
+Startup()

Samples/luainvaders/src/Game.cpp → Samples/lua_invaders/src/Game.cpp

@@ -141,7 +141,7 @@ void Game::Render(Rml::RenderManager& render_manager, float dp_ratio)
 		return;
 
 	if (!texture)
-		texture = render_manager.LoadTexture("luainvaders/data/invaders.tga");
+		texture = render_manager.LoadTexture("lua_invaders/data/invaders.tga");
 
 	// Render all available shields
 	for (int i = 0; i < NUM_SHIELDS; i++)

Samples/luainvaders/src/main.cpp → Samples/lua_invaders/src/main.cpp

@@ -97,7 +97,7 @@ int main(int /*argc*/, char** /*argv*/)
 
 	// Fire off the startup script.
 	LuaInterface::Initialise(Rml::Lua::Interpreter::GetLuaState()); // the tables/functions defined in the samples
-	Rml::Lua::Interpreter::LoadFile(Rml::String("luainvaders/lua/start.lua"));
+	Rml::Lua::Interpreter::LoadFile(Rml::String("lua_invaders/lua/start.lua"));
 
 	bool running = true;
 	while (running)

Samples/luainvaders/lua/start.lua

@@ -1,7 +0,0 @@
-function Startup()
-	maincontext = rmlui.contexts["main"]
-	maincontext:LoadDocument("luainvaders/data/background.rml"):Show()
-	maincontext:LoadDocument("luainvaders/data/main_menu.rml"):Show()
-end
-
-Startup()

Samples/readme.md

@@ -12,25 +12,25 @@ This directory contains the assets shared by all the sample applications.
 
 This directory contains basic applications that demonstrate initialisation, usage, shutdown and installation of custom interfaces.
 
--  `animation` animations and transitions
--  `benchmark` a benchmark to measure performance
--  `bitmapfont` using a custom font engine
--  `customlog` setting up custom logging
--  `databinding` setting up and using data bindings
--  `demo` demonstrates a variety of features in RmlUi and includes a sandbox for playing with RML/RCSS
--  `drag` dragging elements between containers
--  `harfbuzz` advanced text shaping, only enabled when [HarfBuzz](https://harfbuzz.github.io/) is enabled 
--  `loaddocument` loading your first document
--  `lottie` playing Lottie animations, only enabled with the [Lottie plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/lottie.html)
--  `svg` render SVG images, only enabled with the [SVG plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/svg.html)
--  `transform` demonstration of transforms
--  `treeview` using data bindings to create a file browser
+-  `animation`  Animations and transitions.
+-  `benchmark`  A benchmark to measure performance.
+-  `bitmap_font`  Using a custom font engine.
+-  `custom_log`  Setting up custom logging.
+-  `data_binding`  Setting up and using data bindings.
+-  `demo`  Demonstrates a variety of features in RmlUi and includes a sandbox for playing with RML/RCSS.
+-  `drag`  Dragging elements between containers.
+-  `harfbuzz`  Advanced text shaping, only enabled when [HarfBuzz](https://harfbuzz.github.io/) is enabled .
+-  `load_document`  Loading your first document.
+-  `lottie`  Playing Lottie animations, only enabled with the [Lottie plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/lottie.html).
+-  `svg`  Render SVG images, only enabled with the [SVG plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/svg.html).
+-  `transform`  Demonstration of transforms.
+-  `tree_view`  Using data bindings to create a file browser.
 
 #### `invaders`
 
 A full implementation of the 1970s classic Space Invaders using the RmlUi interface.
 
-#### `luainvaders`
+#### `lua_invaders`
 
 Lua version of the invaders sample. Only installed with the Lua plugin.
 

Tests/Source/UnitTests/DataBinding.cpp

@@ -147,7 +147,7 @@ static const String inside_string_rml = R"(
 
 </div>
 </body>
-</rml>	
+</rml>
 )";
 
 static const String aliasing_rml = R"(
@@ -469,7 +469,7 @@ bool InitializeDataBindings(Context* context)
 
 } // Anonymous namespace
 
-TEST_CASE("databinding")
+TEST_CASE("data_binding")
 {
 	Context* context = TestsShell::GetContext();
 	REQUIRE(context);
@@ -487,7 +487,7 @@ TEST_CASE("databinding")
 	TestsShell::ShutdownShell();
 }
 
-TEST_CASE("databinding.inside_string")
+TEST_CASE("data_binding.inside_string")
 {
 	Context* context = TestsShell::GetContext();
 	REQUIRE(context);
@@ -507,7 +507,7 @@ TEST_CASE("databinding.inside_string")
 
 	TestsShell::ShutdownShell();
 }
-TEST_CASE("databinding.aliasing")
+TEST_CASE("data_binding.aliasing")
 {
 	Context* context = TestsShell::GetContext();
 	REQUIRE(context);
@@ -531,7 +531,7 @@ TEST_CASE("databinding.aliasing")
 	TestsShell::ShutdownShell();
 }
 
-TEST_CASE("databinding.dynamic_variables")
+TEST_CASE("data_binding.dynamic_variables")
 {
 	Context* context = TestsShell::GetContext();
 	REQUIRE(context);
@@ -583,7 +583,7 @@ static const String set_enum_rml = R"(
 </rml>
 )";
 
-TEST_CASE("databinding.set_enum")
+TEST_CASE("data_binding.set_enum")
 {
 	Context* context = TestsShell::GetContext();
 	REQUIRE(context);

Tests/Source/UnitTests/ElementFormControlSelect.cpp

@@ -216,7 +216,7 @@ TEST_CASE("form.select.value")
 	TestsShell::ShutdownShell();
 }
 
-TEST_CASE("form.select.databinding")
+TEST_CASE("form.select.data_binding")
 {
 	Context* context = TestsShell::GetContext();
 	REQUIRE(context);

changelog.md

@@ -214,7 +214,7 @@ input { nav: auto; nav-right: #ok_button; }
 - Fix `JoinPath` system interface method being passed through when using the debugger. #462 #603 (thanks @Dakror)
 - Fix some situations where units were not shown in properties, ensure all invoked types define a string converter.
 - In `demo` sample, fix form submit animation not playing smoothly on power saving mode.
-- Fix crash on shutdown in `bitmapfont` sample.
+- Fix crash on shutdown in `bitmap_font` sample.
 
 ### Build improvements
 
@@ -355,7 +355,7 @@ We now have CMake presets:
 
 - `samples` Enable samples but only those without extra dependencies.
 - `samples-all` Enable all samples, also those with extra dependencies.
-- `standalone` Build the library completely without any dependencies, the only sample available is `bitmapfont`.
+- `standalone` Build the library completely without any dependencies, the only sample available is `bitmap_font`.
 - `dev` Enable testing in addition to samples.
 - `dev-all` Enable testing in addition to samples, including those that require extra dependencies.
 

readme.md

@@ -365,8 +365,8 @@ Users can now edit the text field to change the animal. The data bindings ensure
 **Game menu**\
 ![Game menu](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/menu_screen.png)
 
-**Simple game from the 'databinding' sample**\
-![Databinding sample](https://raw.githubusercontent.com/mikke89/RmlUiDoc/df1651db94e69f2977bc0344864ec061b56b104e/assets/gallery/data_binding.png)
+**Simple game from the 'data_binding' sample**\
+![Data binding sample](https://raw.githubusercontent.com/mikke89/RmlUiDoc/df1651db94e69f2977bc0344864ec061b56b104e/assets/gallery/data_binding.png)
 
 **[alt:V](https://altv.mp/) installer - a multiplayer client for GTA:V**\
 ![alt:V installer collage](https://user-images.githubusercontent.com/5490330/230487770-275fe98f-753f-4b35-b2e1-1e20a798f5e8.png)
@@ -465,7 +465,7 @@ See [Source/Debugger/LICENSE.txt](Source/Debugger/LICENSE.txt) - SIL Open Font L
 
 See
 - [Samples/assets/LICENSE.txt](Samples/assets/LICENSE.txt)
-- [Samples/basic/bitmapfont/data/LICENSE.txt](Samples/basic/bitmapfont/data/LICENSE.txt)
+- [Samples/basic/bitmap_font/data/LICENSE.txt](Samples/basic/bitmap_font/data/LICENSE.txt)
 - [Samples/basic/harfbuzz/data/LICENSE.txt](Samples/basic/harfbuzz/data/LICENSE.txt)
 - [Samples/basic/lottie/data/LICENSE.txt](Samples/basic/lottie/data/LICENSE.txt)
 - [Samples/basic/svg/data/LICENSE.txt](Samples/basic/svg/data/LICENSE.txt)