Template:Doc/doc/eo

This is a documentation subpage for Template:Doc.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

La ŝablono {{doc}} designigita por blokon da prion aldoni al diversaj paĝoj (unue ŝablonaj paĝoj). The subpages of a certain language will be loaded into the documentation block depending on the language of the user interface. En la kazo de Angla, la priigo kopiota el la /doc filpaĝo. Sed en ĉiuj aliaj kazoj, la priigo kopiota el la filpaĝo /doc/<lingva kodo>

Iloj

La ĉefiloj lokataj superdekstre, super priiga bloko:

• Krei – opens the creation of the documentation page. Appears only if the documentation page does not exist.Template:ModernNote
• View – opens the documentation page.
• 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 priigan filpaĝon por uzo en pluraj paĝoj.» Se la {{{list}}} parametro uzita, la skribaĵo estos: «Ĉi tio estas priigan filpaĝon 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}}}: the page that will be used as documentation.
• {{{content</lang code>}}}: content that will be used as documentation, instead of a separate page. When used, the main tools are hidden.
• {{{pagespace}}}: the page space is determined automatically, but you can enter your own. The text in the header depends on this parameter:
  • Ŝablono → «Ŝablona Priigo»
  • Dosiero → «Sumo»
  • Uzanto → «Pri»
  • En ĉiuj aliaj kazoj, ĝi nomiĝos «Priigo».

Noto:if {{{pagespace}}} or actual page space is “User”, then the text will be taken from the /about subpage, not /doc.

• {{{tools}}}: controls which tool buttons should be displayed:
  • 0 – no buttons.
  • 1 – only buttons “Create”, “View”, “Edit” and “History”.
  • In all other cases there will be all buttons
• {{{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 priigon

Warning:Se vi volas uzi simbolon “|” ie en teksto (ŝablonoj kaj alia elementoj de MediaViki ne efektitaj), uzu &#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.