mirrors/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD synced 2026-01-15 16:32:41 +01:00
Code Issues Releases Wiki Activity

Change: Use Markdown for changelog.

Browse Source 
Includes minor changes to how version changes are limited for display.
This commit is contained in:
Peter Nelson
2024-10-13 20:20:48 +01:00
committed by Peter Nelson
parent e98407973f
commit 01807fa753
8 changed files with 501 additions and 462 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/help_gui.cpp
View File

@@ -23,7 +23,7 @@
#include "safeguards.h"
static const std::string README_FILENAME = "README.md";
static const std::string CHANGELOG_FILENAME = "changelog.txt";
static const std::string CHANGELOG_FILENAME = "changelog.md";
static const std::string KNOWN_BUGS_FILENAME = "known-bugs.md";
static const std::string LICENSE_FILENAME = "COPYING.md";
@@ -87,33 +87,30 @@ struct GameManualTextfileWindow : public TextfileWindow {
if (this->filename == CHANGELOG_FILENAME) {
this->link_anchors.clear();
this->AfterLoadChangelog();
if (this->GetWidget<NWidgetStacked>(WID_TF_SEL_JUMPLIST)->SetDisplayedPlane(this->jumplist.empty() ? SZSP_HORIZONTAL : 0)) this->ReInit();
} else {
this->TextfileWindow::AfterLoadText();
}
this->TextfileWindow::AfterLoadText();
}
/**
* For changelog files, add a jumplist entry for each version.
* For changelog files, truncate the file after CHANGELOG_VERSIONS_LIMIT versions.
*
* This is hardcoded and assumes "---" are used to separate versions.
* This is hardcoded and assumes "###" is used to separate versions.
*/
void AfterLoadChangelog()
{
/* Look for lines beginning with ---, they indicate that the previous line was a release name. */
uint versions = 0;
/* Look for lines beginning with ###, they indicate a release name. */
for (size_t line_index = 0; line_index < this->lines.size(); ++line_index) {
const Line &line = this->lines[line_index];
if (line.text.find("---", 0) != 0) continue;
if (!line.text.starts_with("###")) continue;
if (this->jumplist.size() >= CHANGELOG_VERSIONS_LIMIT) {
if (versions >= CHANGELOG_VERSIONS_LIMIT) {
this->lines.resize(line_index - 2);
break;
}
/* Mark the version header with a colour, and add it to the jumplist. */
this->lines[line_index - 1].colour = TC_GOLD;
this->lines[line_index].colour = TC_GOLD;
this->jumplist.push_back(line_index - 1);
++versions;
}
}
};