Edit section?

[mattsmith321]

Is there a way to edit only a specific section?

We have an internal MediaWiki (v1.31) which we use to document our systems and applications. We also have a tool that generates Graphviz diagrams for our applications. These diagrams are text-based. I am currently manually creating specifically named sections on the relevant pages and dropping in the relevant diagram text and code. I would like to use WikiClientLibrary to programmatically replace the contents of the specific page when a diagram is updated.

I am able to use ParsePageAsync to iterate through the sections and find the appropriate section. But I am not sure how to use UpdateContentAsync to only update a specific section. It seems that the WikiPage class only deals with a full page. And the ParsedContentInfo and ContentSectionInfo only deal with attributes, not content, on the page.

Any pointers would be appreciated. At this point I am getting close to just dropping to POST'ing the update manually from my diagram tool interface. This would be less than ideal though.

[CXuesong]

There is no currently no way to do so. Frankly speaking, I've never been thinking somebody coming up with this idea because they are also using ParsePageAsync XD

Unfortunately, I've been pretty getting my hands full recently. Until somebody (or me) is able to add that method, you may probably leverage the WikiSite.InvokeMediaWikiApiAsync method to send the MW API request directly. Please refer to the source code of UpdateContentAsync for usage example

WikiClientLibrary/WikiClientLibrary/Pages/WikiPage.cs

Lines 441 to 472 in 02dfd01

	JToken jresult;
	try
	{
	jresult = await Site.InvokeMediaWikiApiAsync(new MediaWikiFormRequestMessage(new
	{
	action = "edit",
	token = WikiSiteToken.Edit,
	title = PageStub.HasTitle ? PageStub.Title : null,
	pageid = PageStub.HasTitle ? null : (int?)PageStub.Id,
	minor = minor,
	bot = bot,
	recreate = true,
	maxlag = 5,
	basetimestamp = LastRevision?.TimeStamp,
	watchlist = watch,
	summary = summary,
	text = Content,
	}), cancellationToken);
	}
	catch (OperationFailedException ex)
	{
	switch (ex.ErrorCode)
	{
	case "protectedpage":
	throw new UnauthorizedOperationException(ex);
	case "unsupportednamespace": // MW 1.19
	case "pagecannotexist": // newer versions
	throw new InvalidOperationException(ex.ErrorMessage, ex);
	default:
	throw;
	}
	}

Please refer to mw:API:Edit on how to edit a specific section.

Note that if I were to add such method to WikiPage, I would make this method independent from WikiPage.Content property. Now I'm beginning to think that a mutable Content property and a UpdateContentAsync method may not be a good design. I'm thinking of something like this

class WikiPage {
    public string Content { get; }
    public Task<bool> UpdateContentAsync(string newContent, string summary, ...);
    public Task<bool> UpdateSectionContentAsync(string sectionId, string newContent, string summary, ...);
    public Task<bool> AddSectionAsync(string sectionTitle, string newContent, string summary, ...);
}

[CXuesong]

Okay I'm a bit late for the party but now this is possible since v0.8.0-int.8.

Please refer to the UT case for usage example:

WikiClientLibrary/UnitTestProject1/Tests/PageTests.cs

Lines 350 to 405 in f07259c

	public async Task WikiPageWriteSectionTest1(string siteName, string pageTitle)
	{
	AssertModify();
	var site = await WikiSiteFromNameAsync(siteName);
	var page = new WikiPage(site, pageTitle);
	await page.RefreshAsync(PageQueryOptions.FetchContent);
	// As a precaution, we don't create new page by editing.
	Assert.True(page.Exists);
	WriteOutput("Existing content");
	WriteOutput(page.Content);
	WriteOutput("Existing sections");
	var sections = Utility.WikitextParseSections(page.Content!);
	ShallowTrace(sections);
	WriteOutput("Adding a section");
	var newSectionTitle = "New section " + DateTime.UtcNow.ToString("O");
	const string PLACEHOLDER = "<Placeholder>";
	var newSectionContent = "Test from WikiClientLibrary.\n\nSection content: " + PLACEHOLDER;
	await page.AddSectionAsync(newSectionTitle, new WikiPageEditOptions
	{
	Content = newSectionContent,
	Summary = SummaryPrefix + $"Append section ([[#{newSectionTitle}]]).",
	Minor = true,
	Bot = true,
	});
	WriteOutput("Updated content");
	await page.RefreshAsync(PageQueryOptions.FetchContent);
	WriteOutput(page.Content);
	Assert.Contains($"== {newSectionTitle} ==\n\n{newSectionContent}", page.Content);
	WriteOutput("Existing sections");
	sections = Utility.WikitextParseSections(page.Content!);
	ShallowTrace(sections);
	// figure out the section number for editing
	var sectionIndex = sections.FindIndex(s => s.Title == newSectionTitle);
	WriteOutput("New section index: {0}", sectionIndex);
	Assert.True(sectionIndex >= 0);
	WriteOutput("Editing a section");
	newSectionContent = sections[sectionIndex].Content.Replace(PLACEHOLDER, Guid.NewGuid().ToString());
	// section #0: content before first heading
	await page.EditSectionAsync(sectionIndex.ToString(), new WikiPageEditOptions
	{
	Content = newSectionContent,
	Summary = SummaryPrefix + $"Edit section ([[#{newSectionTitle}]]).",
	Minor = true,
	Bot = true,
	});
	WriteOutput("Updated content");
	await page.RefreshAsync(PageQueryOptions.FetchContent);
	WriteOutput(page.Content);
	Assert.Contains(newSectionContent, page.Content);
	}