База знаний Центра ПУСК МФТИ:Style guide - История изменений

Олег Давидович: 1 версия импортирована

2024-10-21T09:01:17Z

1 версия импортирована

← Предыдущая версия	Версия от 09:01, 21 октября 2024
(нет различий)

Олег Давидович: 1 версия импортирована

2024-10-18T07:03:28Z

1 версия импортирована

← Предыдущая версия	Версия от 07:03, 18 октября 2024
(нет различий)

Олег Давидович: 1 версия импортирована

2024-10-18T06:42:50Z

1 версия импортирована

← Предыдущая версия	Версия от 06:42, 18 октября 2024
(нет различий)

1>Tsala: /* Describing the location of items */ updates

2024-06-28T10:10:55Z

Describing the location of items: updates

← Предыдущая версия	Версия от 10:10, 28 июня 2024
(нет различий)

1>Tsala: /* Describing the location of items */ updates

2024-06-28T10:10:55Z

Describing the location of items: updates

← Предыдущая версия		Версия от 10:10, 28 июня 2024
Строка 1:		Строка 1:
	{{Help}}		{{Help}}
	==Describing the location of items==		==Describing the location of items==

	* A site admin setting may be referred to as, for example, the setting 'Maximum uploaded file size' in 'Site policies' in Site administration
	* In the Boost theme, we have a navigation drawer and a gear menu. In the Classic theme we have a 'Course administration'
	* In 3.2 we have a menu bar containing a notifications menu and a messages menu

	Examples:		Examples:
	* ~~Grades~~ in the ~~navigation drawer~~		* The setting 'Language autodetect' in 'Site administration > General > Language settings' (with the nav trail in italics).
	* ~~Groups from~~ the ~~gear menu on the Participants page~~		* In the Boost theme, we have a course index and course navigation.
	* '~~Add a new badge~~' from the More.~~.. link in the gear menu on the course page~~		* 'Course navigation > Participants' then from the dropdown select Groups
	* ~~Messages in~~ the user menu		* 'Course navigation > More > Course reuse'.
			* From the user menu (top right) select Preferences then Notifications preferences.
			* 'Course navigation > Grades'.

	== Categories ==		== Categories ==
Строка 21:		Строка 19:

	== Screenshots ==		== Screenshots ==
	* You are encouraged to illustrate documentation with screenshots. Please use the official [https://sandbox.moodledemo.net/ Moodle demo site], or any other site or course using one of the standard themes, and ensure that the screenshot ~~is as small as possible~~.		* You are encouraged to illustrate documentation with screenshots. Please use the official [https://sandbox.moodledemo.net/ Moodle sandbox demo site], or any other site or course using one of the standard themes, and ensure that the screenshot focuses on the specific feature.
	* Screenshots should be ~~GIF, JPEG or~~ PNG format, with 72ppi resolution, and maximum width 800px.		* Screenshots should be preferably PNG format, with 72ppi resolution, and maximum width 800px.
	* To fit more into a screenshot, select a smaller text size for the web page via the View > Text size menu in your web browser.		* To fit more into a screenshot, select a smaller text size for the web page via the View > Text size menu in your web browser.
	* Screenshots ~~can~~ be uploaded using the ~~toolbox [[Special:Upload\|Upload file]] link~~.		* Screenshots should be uploaded using the Images icon in the editor.
	* Please name screenshots ~~descriptively to avoid confusion~~.		* Please name screenshots using the convention 'version number + descriptive name such as page heading' e.g. 404backupsettings.png
	* ~~To include the screenshot~~ in ~~an article~~, ~~use a link in the form <code><nowiki>[[File:Screenshot.png\|~~thumb~~\|alt text]]</nowiki></code>~~.		* Fill in alt text but no caption, not thumb, left aligned.
	* ~~Please do not apply effects such as borders, watermarks or drop shadows to screenshots. This will allow others to~~ add ~~or replace screenshots over time and still maintain~~ a ~~consistent look and feel to articles.~~		* Ideally add a border 1px grey (if no grey background).
	* You can duplicate the look of the [http://school.moodledemo.net/ Mount Orange School] used in many Moodle documentation pages by following [[Standard_themes#Mount_Orange:_example_of_a_customised_More_theme\|these instructions]].
	* For help on image placement and adding an image caption, please refer to the [https://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial Wikipedia Picture tutorial].

	==Templates==		==Templates==
Строка 87:		Строка 83:
	.que .info .grade { display: none; }		.que .info .grade { display: none; }
	</syntaxhighlight>		</syntaxhighlight>
	* You can see many examples of this in [https://docs.moodle.org/~~403~~/en/index.php?title=Quiz_FAQ&action=edit the Quiz FAQ Doc page].		* You can see many examples of this in [https://docs.moodle.org/405/en/index.php?title=Quiz_FAQ&action=edit the Quiz FAQ Doc page].
	* See also the documentation on [[Code syntax highlighting]] that uses the GeSHi (Generic Syntax Highlighter) filter.		* See also the documentation on [[Code syntax highlighting]] that uses the GeSHi (Generic Syntax Highlighter) filter.

1>Leonstr: Replace `with`


2023-07-15T09:22:08Z
Replace <code> with <syntaxhighlight>
Новая страница
{{Help}}

==Describing the location of items==



* A site admin setting may be referred to as, for example, the setting 'Maximum uploaded file size' in 'Site policies' in Site administration

* In the Boost theme, we have a navigation drawer and a gear menu. In the Classic theme we have a 'Course administration'

* In 3.2 we have a menu bar containing a notifications menu and a messages menu



Examples:

* Grades in the navigation drawer

* Groups from the gear menu on the Participants page

* 'Add a new badge' from the More... link in the gear menu on the course page

* Messages in the user menu



== Categories ==

A category is an index of documentation pages.



* A page can be added to a category by typing <code><nowiki>[[Category:Category name]]</nowiki></code>, for example <code><nowiki>[[Category:Site administration]]</nowiki></code>, at the bottom of the page. Many templates automatically categorise pages using the template, for example <code><nowiki>[[Template:Forum]]</nowiki></code> categorises pages into [[:Category:Forum]].

* For '''linking to a category''' you have to add another colon like so: <code><nowiki>[[:Category:FAQ]]</nowiki></code> which will show as [[:Category:FAQ]].

* [[Special:Categories|Categories]] lists all Moodle Docs categories. This can be found in the Toolbox Special pages link.

* For '''further information''' about categories and how they work in MediaWiki, please refer to the [https://en.wikipedia.org/wiki/Wikipedia:Categorization Wikipedia:Categorization].



== Screenshots ==

* You are encouraged to illustrate documentation with screenshots. Please use the official [https://sandbox.moodledemo.net/ Moodle demo site], or any other site or course using one of the standard themes, and ensure that the screenshot is as small as possible.

* Screenshots should be GIF, JPEG or PNG format, with 72ppi resolution, and maximum width 800px.

* To fit more into a screenshot, select a smaller text size for the web page via the View > Text size menu in your web browser. 

* Screenshots can be uploaded using the toolbox [[Special:Upload|Upload file]] link.

* Please name screenshots descriptively to avoid confusion.

* To include the screenshot in an article, use a link in the form <code><nowiki>[[File:Screenshot.png|thumb|alt text]]</nowiki></code>.

* Please do not apply effects such as borders, watermarks or drop shadows to screenshots. This will allow others to add or replace screenshots over time and still maintain a consistent look and feel to articles.

* You can duplicate the look of the [http://school.moodledemo.net/ Mount Orange School] used in many Moodle documentation pages by following [[Standard_themes#Mount_Orange:_example_of_a_customised_More_theme|these  instructions]].

* For help on image placement and adding an image caption, please refer to the [https://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial Wikipedia Picture tutorial].



==Templates==

* In MediaWiki, a template is a page which can be inserted into another page. For example, the Moodle Docs help block on this page is a template.

* A template may be added to a page by typing <code><nowiki>{{Name}}</nowiki></code> for Template:''Name'' (template names are case sensitive).

* [https://docs.moodle.org/en/index.php?title=Special%3AAllpages&from=&namespace=10 All pages (Template namespace)] lists all Moodle Docs templates.

* Please refer to the [http://meta.wikimedia.org/wiki/Help:Template MediaWiki Template help] for further information.



==Moodle Docs editing tags==

*[[MoodleDocs:Deletion|Deletion]] - If you find any page requiring deletion, type <code><nowiki>{{Deletion}}</nowiki></code> at the top of the page.  Use the page comments if necessary to state the reason for deletion.

*[[MoodleDocs:Update|Update]] - Features increase with each Moodle version. If you find a page requiring updating, type <code><nowiki>{{Update}}</nowiki></code> at the top of the page.

*[[:MoodleDocs:Stub|Stub]] - Developers and Moodle Docs administrators may add a new page with a <code><nowiki>{{Stub}}</nowiki></code> tag at the top, requesting help in adding content.

*You can also use the [[Help:Editing#Edit_summary|edit summary]] to communicate the need for more editing. For example, in the page history you might see: "Added section, needs more work, see page comments".



== PHP syntax highlighting ==



* To highlight PHP syntax, enclose the code in tags: 

<pre><nowiki><syntaxhighlight lang="php">... Some PHP code here...</syntaxhighlight></nowiki></pre>



That will be rendered as:



<syntaxhighlight lang="php">

<?php

require_once(dirname(__FILE__) . '/../../config.php');



$cmid = required_param('cmid', 0, PARAM_INT);

if (!$cm = get_coursemodule_from_id('quiz', $id)) {

    print_error('invalidcoursemodule');

}

...

</syntaxhighlight>



* For long code examples you can even add '''line numbering''' like so: 

<pre><nowiki><syntaxhighlight lang="php" line>... A lot of PHP code here...</syntaxhighlight></nowiki></pre>



That will be rendered as:



<syntaxhighlight lang="php" line>

<?php

require_once(dirname(__FILE__) . '/../../config.php');



$cmid = required_param('cmid', 0, PARAM_INT);

if (!$cm = get_coursemodule_from_id('quiz', $id)) {

    print_error('invalidcoursemodule');

}

...

</syntaxhighlight>



* But beware, line numbering makes copying & pasting of code examples more cumbersome!



== CSS syntax highlighting ==



* To highlight CSS syntax, enclose the code in tags: 

<pre><nowiki><syntaxhighlight lang="css">... Some CSS code here...</syntaxhighlight></nowiki></pre>

* Example:

<syntaxhighlight lang="css">

.que .info .grade { display: none; }

</syntaxhighlight>

* You can see many examples of this in [https://docs.moodle.org/403/en/index.php?title=Quiz_FAQ&action=edit the Quiz FAQ Doc page]. 

* See also the documentation on [[Code syntax highlighting]] that uses the GeSHi (Generic Syntax Highlighter) filter.



[[Category:MoodleDocs|Style guide]]

[[de:Moodle Docs StyleGuide]]

[[es:MoodleDocs:Guía de Estilo]]

[[fr:MoodleDocs:Guide de style]]

[[ja:MoodleDocs:スタイルガイド]]

[[zh:MoodleDocs:风格指引]]

База знаний Центра ПУСК МФТИ:Style guide - История изменений

Олег Давидович: 1 версия импортирована

Олег Давидович: 1 версия импортирована

Олег Давидович: 1 версия импортирована

1>Tsala: /* Describing the location of items */ updates

1>Tsala: /* Describing the location of items */ updates

1>Leonstr: Replace with

1>Leonstr: Replace `with`