Template:Doc/doc/eo: Difference between revisions
1416006136 (talk | contribs) mNo edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
<noinclude>{{doc|0}}</noinclude>__NOTOC__ | <noinclude>{{doc|0}}</noinclude>__NOTOC__ | ||
La ŝablono <kbd>{{tl|doc}}</kbd> designigita por blokon da prion aldoni al diversaj paĝoj (unue ŝablonaj paĝoj). | La ŝablono <kbd>{{tl|doc}}</kbd> designigita por blokon da prion aldoni al diversaj paĝoj (unue ŝablonaj paĝoj). La paĝido de partikula lingvo ŝarĝotaj en la priskriba bloko dependante de la lingvo de la interfaco de uzanto. En la kazo de Angla, la priigo kopiota el la {{Code|style=1|<kbd>/doc</kbd>}} paĝido. Sed en ĉiuj aliaj kazoj, la priskribigo kopiota el la paĝido {{Code|style=1|<kbd>/doc/<[[Template:MultiPage|lingva kodo]]></kbd>}}. | ||
==Iloj== | ==Iloj== | ||
La | La ĉefaj iloj lokataj superdekstre, super priiga bloko: | ||
*{{Code|style=2|Krei}} – opens the creation of the documentation page. Appears only if the documentation page does not exist.{{ModernNote|If there isn't any documentations, the button will load a preload documentation, {{Code|[[Template:Doc/preload]]}} or {{Code|Template:Doc/preload/<[[Template:Lang|lang code]]>}} (if the UI language isn't English and the translations of the preload page exist), as the content of the new page and open the editing page. If there is a English documentation, the button will preload the English documentation as the content.}} | *{{Code|style=2|Krei}} – opens the creation of the documentation page. Appears only if the documentation page does not exist.{{ModernNote|If there isn't any documentations, the button will load a preload documentation, {{Code|[[Template:Doc/preload]]}} or {{Code|Template:Doc/preload/<[[Template:Lang|lang code]]>}} (if the UI language isn't English and the translations of the preload page exist), as the content of the new page and open the editing page. If there is a English documentation, the button will preload the English documentation as the content.}} | ||
*{{Code|style=2| | *{{Code|style=2|Vidi}} – Vidi la priskriban paĝon. | ||
*{{Code|style=2|Redakti}} – opens the editing of the documentation page. | *{{Code|style=2|Redakti}} – opens the editing of the documentation page. | ||
*{{Code|style=2|Historio de Paĝo}} – opens the history of changes to the documentation page.{{ModernNote|If there are none of the above tools, then the text of the documentation was written using the {{param|content}} parameter, or parameter {{param|tools}} was set to 0.}} | *{{Code|style=2|Historio de Paĝo}} – opens the history of changes to the documentation page.{{ModernNote|If there are none of the above tools, then the text of the documentation was written using the {{param|content}} parameter, or parameter {{param|tools}} was set to 0.}} | ||
Line 27: | Line 27: | ||
**2 – montros la mesaĝon “This page is not a sandbox”. | **2 – montros la mesaĝon “This page is not a sandbox”. | ||
**3 – montros la mesaĝon «Ĉi tio estas la <paĝon> scia filpaĝo.» Useful for user subpages. | **3 – montros la mesaĝon «Ĉi tio estas la <paĝon> scia filpaĝo.» Useful for user subpages. | ||
**4 – montros la mesaĝon «Ĉi tio estas | **4 – montros la mesaĝon «Ĉi tio estas priskribigan paĝidon por uzo en pluraj paĝoj.» Se la {{param|list}} parametro uzita, la skribaĵo estos: «Ĉi tio estas priskribigan paĝidon por uzo en pluraj paĝoj listigitaj en <listpaĝo>.» | ||
*{{param|list}}: specifies a page or category that lists pages using a particular documentation page. Used only if parameter {{param|1}} is set to 4. | *{{param|list}}: specifies a page or category that lists pages using a particular documentation page. Used only if parameter {{param|1}} is set to 4. | ||
*{{param|docpage}}: | *{{param|docpage}}: Ligilo de paĝo kiu uzota por priskribo. | ||
*{{param|content</ | *{{param|content</lingva kodo>}}: uzu uzotan priskribonta enhavon anstataŭ paĝo. Se ĝi uzita, la ĉefaj iloj kaŝitaj. | ||
*{{param|pagespace}}: | *{{param|pagespace}}: paĝspaco aŭtomate asignita, sed povas ankaŭ malaŭtomate asignita. The text in the header depends on this parameter: | ||
**Ŝablono → «Ŝablona Priigo» | **Ŝablono → «Ŝablona Priigo» | ||
**Dosiero → «Sumo» | **Dosiero → «Sumo» | ||
Line 40: | Line 40: | ||
**0 – no buttons. | **0 – no buttons. | ||
**1 – only buttons “Create”, “View”, “Edit” and “History”. | **1 – only buttons “Create”, “View”, “Edit” and “History”. | ||
** | **Alikaze, ĉiuj ŝaltbutonoj malkaŝitaj. | ||
*{{param|examples}}: examples that can be copied and used on other pages go here. When used, the “Examples” button appears, on the left under the title of the documentation block. | *{{param|examples}}: examples that can be copied and used on other pages go here. When used, the “Examples” button appears, on the left under the title of the documentation block. | ||
*{{param|noscroll}}: if you are using the {{param|examples}} parameter with few examples, this setting will turn off the right extra padding (scrollbar-gutter) needed for the scrollbar. | *{{param|noscroll}}: if you are using the {{param|examples}} parameter with few examples, this setting will turn off the right extra padding (scrollbar-gutter) needed for the scrollbar. | ||
==Kreas | ==Kreas priskribigon== | ||
{{warning|Se vi volas uzi simbolon “|” ie en teksto (ŝablonoj kaj alia elementoj de MediaViki ne efektitaj), uzu {{code|select=1|&#124;}}-on.}} | {{warning|Se vi volas uzi simbolon “|” ie en teksto (ŝablonoj kaj alia elementoj de MediaViki ne efektitaj), uzu {{code|select=1|&#124;}}-on.}} | ||
To start creating documentation, click on the “Create” button on the top right. The button loads the preloaded document (or as a preloaded document if there is an English document). Then the text of the documentation itself is written. First there is a brief description, and then – depending on what the documentation is written for. If you want to add categories, just add them where the preload documentation indicated. | To start creating documentation, click on the “Create” button on the top right. The button loads the preloaded document (or as a preloaded document if there is an English document). Then the text of the documentation itself is written. First there is a brief description, and then – depending on what the documentation is written for. If you want to add categories, just add them where the preload documentation indicated. | ||
{{Doc/Sandbox other|[[Category:Esperanto]]}} | {{Doc/Sandbox other|[[Category:Esperanto]]}} |
Revision as of 14:44, 24 April 2023

Don't forget to purge the contents of the base page upon creating or editing this subpage.
La ŝablono {{doc}}
designigita por blokon da prion aldoni al diversaj paĝoj (unue ŝablonaj paĝoj). La paĝido de partikula lingvo ŝarĝotaj en la priskriba bloko dependante de la lingvo de la interfaco de uzanto. En la kazo de Angla, la priigo kopiota el la /doc paĝido. Sed en ĉiuj aliaj kazoj, la priskribigo kopiota el la paĝido /doc/<lingva kodo>.
Iloj
La ĉefaj iloj lokataj superdekstre, super priiga bloko:
- Krei – opens the creation of the documentation page. Appears only if the documentation page does not exist.Template:ModernNote
- Vidi – Vidi la priskriban paĝon.
- Redakti – opens the editing of the documentation page.
- Historio de Paĝo – opens the history of changes to the documentation page.Template:ModernNote
Also, in the upper right corner there is a button marked with an ellipsis [ … ]. It expands/collapses additional tools:
- Sandbox – opens the creation of a subpage /sandbox and copies the code of the original page, or, if this page exists, simply opens it.
- Provkazo – opens the /testcases subpage. Useful for testing a template in different situations.
- Filpaĝoj – opens Special:PrefixIndex and inserts the page name to search for all subpages.
- Refreŝigi – opens a window with a message about purging the page.
Language bar
On the top right, under the tools, there are flags that switch documentation to another language. Switching is implemented by inserting &uselang=<lang code> into the page link, so if you click on another language, then along with the documentation, the interface language will change.
If there is no documentation in a certain language, the message “The <page> documentation page does not exist” will be displayed. if {{{pagespace}}} or actual page space is User, then the message “The <user> did not provide information about himself on this language (<page>).” will be displayed instead. Also, after this message, documentation in English will be displayed, if it exists.
Parametroj
- {{{1}}}: parameter for switching the template assignment:
- If you need a standard documentation block, do not enter anything in this parameter.
- 0 – montros la mesaĝon «Ĉi tio estas priigan filpaĝon por <paĝo>.»
- 1 – montros la mesaĝon “This is the sandbox subpage for <page>”.
- 2 – montros la mesaĝon “This page is not a sandbox”.
- 3 – montros la mesaĝon «Ĉi tio estas la <paĝon> scia filpaĝo.» Useful for user subpages.
- 4 – montros la mesaĝon «Ĉi tio estas priskribigan paĝidon por uzo en pluraj paĝoj.» Se la {{{list}}} parametro uzita, la skribaĵo estos: «Ĉi tio estas priskribigan paĝidon por uzo en pluraj paĝoj listigitaj en <listpaĝo>.»
- {{{list}}}: specifies a page or category that lists pages using a particular documentation page. Used only if parameter {{{1}}} is set to 4.
- {{{docpage}}}: Ligilo de paĝo kiu uzota por priskribo.
- {{{content</lingva kodo>}}}: uzu uzotan priskribonta enhavon anstataŭ paĝo. Se ĝi uzita, la ĉefaj iloj kaŝitaj.
- {{{pagespace}}}: paĝspaco aŭtomate asignita, sed povas ankaŭ malaŭtomate asignita. The text in the header depends on this parameter:
- Ŝablono → «Ŝablona Priigo»
- Dosiero → «Sumo»
- Uzanto → «Pri»
- En ĉiuj aliaj kazoj, ĝi nomiĝos «Priigo».

- {{{tools}}}: controls which tool buttons should be displayed:
- 0 – no buttons.
- 1 – only buttons “Create”, “View”, “Edit” and “History”.
- Alikaze, ĉiuj ŝaltbutonoj malkaŝitaj.
- {{{examples}}}: examples that can be copied and used on other pages go here. When used, the “Examples” button appears, on the left under the title of the documentation block.
- {{{noscroll}}}: if you are using the {{{examples}}} parameter with few examples, this setting will turn off the right extra padding (scrollbar-gutter) needed for the scrollbar.
Kreas priskribigon

To start creating documentation, click on the “Create” button on the top right. The button loads the preloaded document (or as a preloaded document if there is an English document). Then the text of the documentation itself is written. First there is a brief description, and then – depending on what the documentation is written for. If you want to add categories, just add them where the preload documentation indicated.