Help:Add new Honor - Revision history

W126jep at 20:11, 18 February 2024

2024-02-18T20:11:17Z

DesignerThan: added an example to the localization section

2024-02-18T14:55:20Z

added an example to the localization section

Jomegat: /* Upload Honor Patch */

2024-02-16T02:31:22Z

Upload Honor Patch

Jomegat at 02:24, 16 February 2024

2024-02-16T02:24:01Z

DesignerThan at 14:44, 11 February 2024

2024-02-11T14:44:09Z

DesignerThan at 14:43, 11 February 2024

2024-02-11T14:43:41Z

DesignerThan at 09:50, 11 February 2024

2024-02-11T09:50:47Z

Jomegat: clarify

2023-10-04T00:52:35Z

clarify

Jomegat: copy editing

2023-10-04T00:50:46Z

copy editing

DesignerThan at 15:02, 3 October 2023

2023-10-03T15:02:57Z

@@ Line 7: / Line 7: @@
 == Create an entry in [[Localization:Honors]]==
-The honor name is extracted from the [[Localization:Honors]] page.  If this step is omitted, the page name will show up as "AY Honor" with no honor name.  Add the honor to the localization page in alphabetical order, using the [[Template:SaveLocalizationHonors]] template, specifying its English name as both the id and the text arguments. '''ATTENTION:''' don't separate the <code><nowiki><!--T:????--></nowiki></code>-comment from the template-call. These comments are used for translation. Just make line breaks AFTER a template-call and insert the new one there.
+The honor name is extracted from the [[Localization:Honors]] page. If this step is omitted, the page name will show up as "AY Honor" with no honor name. Add the honor to the localization page in alphabetical order, using the [[Template:SaveLocalizationHonors]] template, specifying its English name as both the id and the text arguments. '''ATTENTION:''' don't separate the <code><nowiki><!--T:????--></nowiki></code>-comment from the template-call. These comments are used for translation. Just make line breaks AFTER a template-call and insert the new one there.
 Then mark the page for translation and translate the text field into the languages of interest (ideally, all the languages supported by the wiki).
@@ Line 54: / Line 54: @@
 === Upload Honor Patch ===
 To add the image for the honor page, click on "Tools" in the bottom left and select "Upload File". Follow the process and select "Pathfinder Insignia" for the "Licensing" field.
-For the filename we have the following convention <code><honorname> AY Honor.png</code>.  The png should have a transparent background.
+For the filename we have the following convention <code><honorname> AY Honor.png</code>. The png should have a transparent background.
 == Create the Requirements Page ==
@@ Line 84: / Line 84: @@
 The requirements are also enclosed by section-tags. The names of these start with "req", followed by the requirement number. Between the section-tags the translate-tags need to be opened and closed. To prevent them from being included on other pages they need to be surrounded by noinclude-tags. For the sake of styling the whole requirement is surrounded by the b-tags to make the text bold.
-Next, one needs to define the requirement that is the challenging part of the honor. That is again done by using the section-tags using the section name "challenge". In the example that would be the N-th requirement.  The challenging part of an honor may include sub-requirements.
+Next, one needs to define the requirement that is the challenging part of the honor. That is again done by using the section-tags using the section name "challenge". In the example that would be the N-th requirement. The challenging part of an honor may include sub-requirements.
 == Create the Answer Key's Page ==
@@ Line 114: / Line 114: @@
 The page needs to start with the Template-Call of [[Template:HonorSubpage|HonorSubpage]]. It generates the Honor-Navigation, Language Switcher, the Infobox and the basic page structure. At the end of the page, the Template [[Template:CloseHonorPage|CloseHonorPage]] needs to be called, to close the HTML-Page-Structure.
-Rather than retyping the requirement on the answer key, we include the requirement from the Requirements page directly so that if the requirement changes, it only has to be update in one place.  To include the requirement from the requirements page add the [[Template:ansreq|ansreq-template]]  with the <code>num</code>-Argument set to the number of the wanted requirement. After that, the opening translate-tag is needed, surrounded by noinclude-tags. For the readability it is common to add the text of the requirement inside of an HTML Comment after that. Now the answer can be written.
+Rather than retyping the requirement on the answer key, we include the requirement from the Requirements page directly so that if the requirement changes, it only has to be update in one place. To include the requirement from the requirements page add the [[Template:ansreq|ansreq-template]] with the <code>num</code>-Argument set to the number of the wanted requirement. After that, the opening translate-tag is needed, surrounded by noinclude-tags. For the readability it is common to add the text of the requirement inside of an HTML Comment after that. Now the answer can be written.
 After the answer the closing translate-tag needs to be added, again surrounded by noinclude-tags. Then the [[Template:CloseReq|CloseReq]]-Template needs to be called.
 This section needs to be repeated for each of the requirements. If there are sub-requirements just add another requirement section where the answer goes, but nest the sub-requirements between the parent requirement's ansreq and CloseReq templates.

@@ Line 7: / Line 7: @@
 == Create an entry in [[Localization:Honors]]==
-The honor name is extracted from the [[Localization:Honors]] page.  If this step is omitted, the page name will show up as "AY Honor" with no honor name.  Add the honor to the localization page, using the [[Template:SaveLocalizationHonors]] template, specifying its English name as both the id and the text arguments.  Then mark the page for translation and translate the text field into the languages of interest (ideally, all the languages supported by the wiki).
+The honor name is extracted from the [[Localization:Honors]] page.  If this step is omitted, the page name will show up as "AY Honor" with no honor name.  Add the honor to the localization page in alphabetical order, using the [[Template:SaveLocalizationHonors]] template, specifying its English name as both the id and the text arguments. '''ATTENTION:''' don't separate the <code><nowiki><!--T:????--></nowiki></code>-comment from the template-call. These comments are used for translation. Just make line breaks AFTER a template-call and insert the new one there.
 == Create the Honor Landing Page ==

@@ Line 43: / Line 43: @@
 === Upload Honor Patch ===
-To add the image for the honor page, click on "Tools" in the bottom left and select "Upload File". Follow the process and select the correct license.
+To add the image for the honor page, click on "Tools" in the bottom left and select "Upload File". Follow the process and select "Pathfinder Insignia" for the "Licensing" field.
-For the filename we have the following convention <code><honorname> AY Honor.png</code>.
+For the filename we have the following convention <code><honorname> AY Honor.png</code>.  The png should have a transparent background.
 == Create the Requirements Page ==

@@ Line 3: / Line 3: @@
 __TOC__
 </div>
 This page describes how to add a new honor to the wiki. To understand which pages are important for an honor, read the section about the [[Pathfinder_Wiki:Structure|Structure of an Honor]].
 == Create the Honor Landing Page ==

@@ Line 24: / Line 24: @@
 |primary=AY Honors/Scrapbooking
 }}
 == {{Localize|Overview}}==
@@ Line 40: / Line 36: @@
 {{CloseHonorPage}}
 </syntaxhighlight >
 == Create the Requirements Page ==

← Older revision		Revision as of 00:52, 4 October 2023
Line 94:		Line 94:
	After the answer the closing translate-tag needs to be added, again surrounded by noinclude-tags. Then the [[Template:CloseReq\|CloseReq]]-Template needs to be called.		After the answer the closing translate-tag needs to be added, again surrounded by noinclude-tags. Then the [[Template:CloseReq\|CloseReq]]-Template needs to be called.

−	This section needs to be repeated for each of the requirements. If there are sub-requirements just add another requirement section where the answer goes, but nest the sub-requirements between the ansreq and CloseReq templates.	+	This section needs to be repeated for each of the requirements. If there are sub-requirements just add another requirement section where the answer goes, but nest the sub-requirements between the parent requirement's ansreq and CloseReq templates.

@@ Line 3: / Line 3: @@
 __TOC__
 </div>
-Here you'll find a guide on how to add a new honor to the wiki. To know which pages are important for an honor, read the section about the [[Pathfinder_Wiki:Structure|Structure of an Honor]].
+This page describes how to add a new honor to the wiki. To understand which pages are important for an honor, read the section about the [[Pathfinder_Wiki:Structure|Structure of an Honor]].
 == Create the Honor Landing Page ==
-That is the first page that need's to be created. It has the following structure: The Honor Navigation, followed by an Overview and the Challenging-Part-Section. On the right side it has the infobox that is displaying the most important information about an honor.
+That is the first page that needs to be created. It has the following structure: The Honor Navigation, followed by an Overview and the Challenging-Part-Section. On the right side it has the infobox that is displaying the most important information about an honor.
-Source Code wise it has the following structure: Template call of [[Template:HonorLanding|HonorLanding]] followed by the Overview and the Challenging-Part-Section. The content ends with a call of the [[Template:CloseHonorPage|CloseHonorPage-Template]] Use the following code as a starting point and set the needed arguments of the [[Template:HonorLanding|HonorLanding Template]], they are described in the documentation of the template, and write an awesome overview. Then the Landing Page should be finished.
+The source code will have the following structure: Template call of [[Template:HonorLanding|HonorLanding]] followed by the Overview and the Challenging-Part-Section. The content ends with a call of the [[Template:CloseHonorPage|CloseHonorPage-Template]] Use the following code as a starting point and set the needed arguments of the [[Template:HonorLanding|HonorLanding Template]], they are described in the documentation of the template, and write an awesome overview. Then the Landing Page should be finished.
 <syntaxhighlight lang="html+handlebars" style="overflow:auto">
@@ Line 57: / Line 57: @@
 </syntaxhighlight >
-The page needs to start with the Template-Call of [[Template:HonorSubpage|HonorSubpage]]. It generates the Honor-Navigation, Language Switcher, the Infobox and the basic page structure. At the end of the page, the Template [[Template:CloseHonorPage|CloseHonorPage]] needs to be called, to close the HTML-Page-Structure. Between the two Templage calls the <code><section begin=Body /></code>-Tag and the <code><section end=Body /></code>-Tag is needed. The section-tags enable the wiki, to include the enclosed content, on other pages, by the name of the section. Each section name, needs to be unique on the page.
+The page needs to start with the Template-Call of [[Template:HonorSubpage|HonorSubpage]]. It generates the Honor-Navigation, Language Switcher, the Infobox and the basic page structure. At the end of the page, the Template [[Template:CloseHonorPage|CloseHonorPage]] needs to be called, to close the HTML-Page-Structure. Between the two Template calls the <code><section begin=Body /></code>-Tag and the <code><section end=Body /></code>-Tag is needed. The section-tags enable the wiki to include the enclosed content on other pages, by simply supplying the name of the section. Each section name must be unique on the page.
-The requirements are also enclosed by section-tags. The names of these start with "req", followed by the requirement number. Between the section-tags the translate-tags need to be opened and closed. That they aren't included on other pages they need to be surrounded by noinclude-tags. For the sake of styling the whole requirement is surrounded by the b-tags, those make the text bold.
+The requirements are also enclosed by section-tags. The names of these start with "req", followed by the requirement number. Between the section-tags the translate-tags need to be opened and closed. To prevent them from being included on other pages they need to be surrounded by noinclude-tags. For the sake of styling the whole requirement is surrounded by the b-tags to make the text bold.
-Next one needs to define the requirement that is the challenging part of the honor. That is again done by using the section-tags using the section name "challenge". In the example that would be the N-th requirement.
+Next, one needs to define the requirement that is the challenging part of the honor. That is again done by using the section-tags using the section name "challenge". In the example that would be the N-th requirement.  The challenging part of an honor may include sub-requirements.
 == Create the Answer Key's Page ==
-As for the Requirements page, open the honors landing page and click on the answer key page, to create it. The following code is the template for the new page.
+As with the Requirements page, open the honors landing page and click on the answer key page, to create it. The following code is the template for the new page.
 <syntaxhighlight lang="html+handlebars" style="overflow:auto">
 {{HonorSubpage}}
 {{ansreq|page={{#titleparts:{{PAGENAME}}|2|1}}|num=1}}
 <noinclude><translate>
@@ Line 87: / Line 86: @@
 {{CloseReq}}
 {{CloseHonorPage}}
 </syntaxhighlight >
-The page needs to start with the Template-Call of [[Template:HonorSubpage|HonorSubpage]]. It generates the Honor-Navigation, Language Switcher, the Infobox and the basic page structure. At the end of the page, the Template [[Template:CloseHonorPage|CloseHonorPage]] needs to be called, to close the HTML-Page-Structure. Between the two Templage calls the <code><section begin=Body /></code>-Tag and the <code><section end=Body /></code>-Tag is needed. The section-tags enable the wiki, to include the enclosed content, on other pages, by the name of the section. Each section name, needs to be unique on the page.
+The page needs to start with the Template-Call of [[Template:HonorSubpage|HonorSubpage]]. It generates the Honor-Navigation, Language Switcher, the Infobox and the basic page structure. At the end of the page, the Template [[Template:CloseHonorPage|CloseHonorPage]] needs to be called, to close the HTML-Page-Structure.
-To create the answer-section for a requirement, the [[Template:ansreq|ansreq-template]] needs to be called with the <code>num</code>-Argument set to the number of the wanted requirement. After that the opening translate-tag is needed, surrounded by noinclude-tags. For the readability it is common to add the text of the requirement inside of an HTML Comment after that. Now the answer can be written.
+Rather than retyping the requirement on the answer key, we include the requirement from the Requirements page directly so that if the requirement changes, it only has to be update in one place.  To include the requirement from the requirements page add the [[Template:ansreq|ansreq-template]]  with the <code>num</code>-Argument set to the number of the wanted requirement. After that, the opening translate-tag is needed, surrounded by noinclude-tags. For the readability it is common to add the text of the requirement inside of an HTML Comment after that. Now the answer can be written.
 After the answer the closing translate-tag needs to be added, again surrounded by noinclude-tags. Then the [[Template:CloseReq|CloseReq]]-Template needs to be called.
-This section needs to be repeated as long as there are requirements. If there are sub-requirements just add a requirement section, where the answer goes.
+This section needs to be repeated for each of the requirements. If there are sub-requirements just add another requirement section where the answer goes, but nest the sub-requirements between the ansreq and CloseReq templates.

← Older revision		Revision as of 15:02, 3 October 2023
Line 62:		Line 62:

	Next one needs to define the requirement that is the challenging part of the honor. That is again done by using the section-tags using the section name "challenge". In the example that would be the N-th requirement.		Next one needs to define the requirement that is the challenging part of the honor. That is again done by using the section-tags using the section name "challenge". In the example that would be the N-th requirement.
		+
		+	== Create the Answer Key's Page ==
		+	As for the Requirements page, open the honors landing page and click on the answer key page, to create it. The following code is the template for the new page.
		+
		+	<syntaxhighlight lang="html+handlebars" style="overflow:auto">
		+	{{HonorSubpage}}
		+
		+	<section begin="Body" />
		+	{{ansreq\|page={{#titleparts:{{PAGENAME}}\|2\|1}}\|num=1}}
		+	<noinclude><translate>
		+	</noinclude>
		+	<!-- The text of the first requirement, helps to know what it is about. -->
		+	The answer of the first requirement
		+
		+	<noinclude></translate></noinclude>
		+	{{CloseReq}}
		+	{{ansreq\|page={{#titleparts:{{PAGENAME}}\|2\|1}}\|num=N}}
		+	<noinclude><translate>
		+	</noinclude>
		+	<!-- The text of the N-th requirement, helps to know what it is about. -->
		+	The answer of the N-th requirement.
		+
		+	<noinclude></translate></noinclude>
		+	{{CloseReq}}
		+
		+	<section end="Body" />
		+	{{CloseHonorPage}}
		+	</syntaxhighlight >
		+
		+	The page needs to start with the Template-Call of [[Template:HonorSubpage\|HonorSubpage]]. It generates the Honor-Navigation, Language Switcher, the Infobox and the basic page structure. At the end of the page, the Template [[Template:CloseHonorPage\|CloseHonorPage]] needs to be called, to close the HTML-Page-Structure. Between the two Templage calls the <code><section begin=Body /></code>-Tag and the <code><section end=Body /></code>-Tag is needed. The section-tags enable the wiki, to include the enclosed content, on other pages, by the name of the section. Each section name, needs to be unique on the page.
		+
		+	To create the answer-section for a requirement, the [[Template:ansreq\|ansreq-template]] needs to be called with the <code>num</code>-Argument set to the number of the wanted requirement. After that the opening translate-tag is needed, surrounded by noinclude-tags. For the readability it is common to add the text of the requirement inside of an HTML Comment after that. Now the answer can be written.
		+	After the answer the closing translate-tag needs to be added, again surrounded by noinclude-tags. Then the [[Template:CloseReq\|CloseReq]]-Template needs to be called.
		+
		+	This section needs to be repeated as long as there are requirements. If there are sub-requirements just add a requirement section, where the answer goes.