Changes for page Documentation Guide
Last modified by Lucas Charpentier (Sereza7) on 2023/11/29 11:11
Change comment:
Added explanation about SCM macro
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -113,7 +113,36 @@ 113 113 * Now that you have added text you should use links to point to other useful resources outside the page 114 114 * Don't use URLs for links to xwiki.org. If the URL format or the domain get changed the links will be broken. You should use the ##wiki:Space.Name## notation instead. 115 115 * More information about links, including differences between the different syntaxes, can be found by reading the [[XWiki Syntax page>>platform:Main.XWikiSyntax#HLinks]] 116 +* If you wish to link to a file on GitHub you must use the ##~{~{scm}}## macro. The rationale is that this will allow us to change SCM without breaking all our URLs (which is what we experienced when we moved from Subversion to GitHub). Here's how it works:((( 116 116 118 +Examples: 119 + 120 +{{code language="none"}} 121 +{{scm/}} 122 + 123 +{{scm project="xwiki-rendering"/}} 124 + 125 +{{scm project="xwiki-commons" path="xwiki-commons-core/pom.xml"/}} 126 + 127 +{{scm branch="stable-3.1.x" path="xwiki-platform-core/pom.xml"/}} 128 + 129 +{{scm path="xwiki-platform-core/pom.xml"/}} 130 + 131 +{{scm branch="stable-3.1.x" path="xwiki-platform-core/pom.xml"}}With **label**{{/scm}} 132 + 133 +{{scm branch="stable-3.1.x" path="xwiki-platform-core/pom.xml" raw="true"/}} 134 +{{/code}} 135 + 136 +Parameters: 137 + 138 +|= Parameter name |= Default value |= Description 139 +| user | xwiki | the github user 140 +| project | xwiki-platform | the repository name in the provided user 141 +| branch | master | the branch or tag 142 +| raw | false | UI or raw content 143 +| path | empty string | the resource in the repository 144 +))) 145 + 117 117 = Screen shots / Images = 118 118 119 119 It is recommended to use images to illustrate the content you are writing about. There are some practices it's best to follow with respect to images: