Wiki source code of Handle Original Documentation Pages
Last modified by Eleni Cojocariu on 2026/02/20 16:27
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | After moving content to the [[new documentation location>>xwiki:documentation.WebHome]], it is important to properly handle the original (old) documentation pages. This ensures that: | ||
| 6 | |||
| 7 | * old links still work for users, | ||
| 8 | * no duplicate content remains, | ||
| 9 | * pages on [[Extensions>>extensions:Main.WebHome]] continue to provide technical information. | ||
| 10 | |||
| 11 | == When Moving Part of a Page == | ||
| 12 | |||
| 13 | When you move one or more sections: | ||
| 14 | |||
| 15 | ((( | ||
| 16 | * Do not remove the old section entirely. Keep the title of the section (i.e., the heading), and use the section to point to the new page/s. | ||
| 17 | * If you want to rename a section or remove its title, insert an "id name" with the old name of the section (e.g., {{code language="none"}} {{id name="HSectionName"/}} {{/code}}). This way, users that have the old link saved can still reach the information they are interested in by finding their way to the new URL. | ||
| 18 | * You can use the [[redirect syntax>>snippets:Extension.Redirect]] to link the new page from the old page. | ||
| 19 | ))) | ||
| 20 | |||
| 21 | == When the Page No Longer Contains Documentation Content == | ||
| 22 | |||
| 23 | This section applies when a page no longer contains documentation content, either because the documentation was moved to a new location, or because the page is an extension page newly [[imported>>extensions:ExtensionCode.ImportExtension]] and only contains technical information such as dependencies or prerequisites. | ||
| 24 | |||
| 25 | * If the page is from [["/Documentation">>xwiki:Documentation.WebHome]], you just need to [[replace existing backlinks with links to the new pages>>||anchor="HReplaceExistingBacklinkswithLinkstotheNewPages"]]. | ||
| 26 | * If the page is from the [[Extension sub-wiki>>extensions:Main.WebHome]] and represents an extension page, do not remove it, as it still contains other technical information (e.g., dependencies, prerequisites). Instead, make sure to correctly [[handle Extensions.XWiki.org pages when you are migrating and refactoring>>Community.DocGuide.HandleExtensionPages.WebHome||anchor="HYouareMigratingExistingDocumentation"]] and to [[replace existing backlinks with links to the new pages>>||anchor="HReplaceExistingBacklinkswithLinkstotheNewPages"]]. | ||
| 27 | |||
| 28 | === Replace Existing Backlinks with Links to the New Pages === | ||
| 29 | |||
| 30 | After moving the entire page, whether from the [[main wiki>>xwiki:Documentation.WebHome]] or the [[Extensions>>extensions:Main.WebHome]] sub-wiki, it is important to check the [[backlinks>>xwiki:documentation.xs.user.base.page.linking-references.WebHome||anchor="HBacklinks"]] of the original page. For each documentation page that appears in the "Backlinks" of the original page, update the corresponding link or links so that they point to the new documentation page location. This ensures that users are directed to the updated content. |
