Как формат статьи

Материал из Ru Ikoula wiki
Jump to navigation Jump to search

nl:Hoe te formatteren van artikel it:Come formattare articolo pt:Como formatar o artigo es:Cómo formato artículo en:How to format article ja:記事の書式を設定する方法 ar:كيفية تنسيق المادة zh:如何设置格式文章 ro:Cum sa format articolul pl:Jak sformatować art fr:Comment formater son article

Эта статья является результатом автоматического перевода, выполняемого программного обеспечения. Вы можете посмотреть исходный статьи здесь.







Эта статья описывает как форматировать ваш учебник. Следуя этого руководства и один на стиль написания, ваш учебник будет применять рекомендации ikoula.


Вики-синтаксис

Обучающие ikoula должен быть отформатирован с использованием вики-синтаксис. Эта статья даст вам наиболее распространенные примеры использования этого синтаксиса. Вы можете найти более подробную информацию в раздел помощи MediaWiki что касается Вики форматирования.


Главах

Разрезать ваши учебники на главы, можно использовать уровни правового титула. Как только вы положили название на странице, все из следующих элементов будут рассматриваться как часть новой главы, до следующей название того же уровня.
Это может быть очень полезным для улучшения читаемости вашей статьи путем вырезания на различных стадиях реализации.

Различные уровни титул

Название уровня 1 соответствует заголовку статьи. Он создается автоматически при создании вашей страницы. Треки строятся вокруг вашего названия знаками "=". Название уровня 2 соответствует первый титул главы или раздела.
Пример заголовка данного раздела :

==Chapitres==

Больше вы будете подписать вокруг вашего названия, чем больше вы идете вниз по дереву.

Пример Результат 
===Titre de niveau 3===
====Titre de niveau 4====
=====Titre de niveau 5=====

Titre de niveau 3

Titre de niveau 4

Titre de niveau 5


Стоит отметить, что содержание автоматически появляется во главе статьи, как только есть по крайней мере 4 главы и подглавы.

Стили

Вы можете отформатировать текст с использованием синтаксиса wiki и несколько HTML-теги.

Смелые

Вот как положить конец полужирным шрифтом в вашей статье.

Пример Результат 
'''полужирный текст '''

texte en gras


Вот список элементов, которые должны быть выделены жирным шрифтом.

  • Видимый текст GUI
  • Изменение контекста для элемента управления, такие как изменение пользователя или сервера
  • Хостов как Сервер - 1
  • Пользователи любят ikoula
  • Быстрый
  • Список терминов, как :
    • MySQL: компонент database engine
    • Apache: WebServer
  • Элементы, которые игрок не должен пропустить, сделать это без слишком много.


Курсив

Курсив должен использоваться только для представления технических терминов. Например : как будет использоваться сервер nginx обратный прокси .

Пример Результат 
''курсивом текста ''

texte en курсив


Примечания и предупреждения

Использование некоторых HTML-теги могут быть необходимы для выделения определенных элементов, таких как нот или предупреждений.

Пример Результат 
<div style="background-color: #FFCC99;"> '''Примечание ''': Это Примечание. </div>



<div style="background-color: #FF9999;"> '''Предупреждение ''': Это предупреждение. </div>
Note: Ceci est une note.


Warning: Ceci est un avertissement.



Blockquotes

blockquotes Это блоки, где ваш текст форматируется по-разному. Чтобы сделать это, просто поставить пробел в начале предложения, или заключите текст из тегов  <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.


Пример Результат

Важные текстовые ''italique''
ou
<pre>Texte important ''italique''</pre> 

Texte important italique

ou 

Texte important ''italique''

Как вы отметили, использование тега <pre> fait que tout autre formatage à l'intérieur du bloc sera ignoré et considéré comme du texte à afficher. Si vous utilisez la première méthode, avec l'espace en début de ligne, sachez qu'un retour à la ligne fermera le cadre.
Nous préconisons d'Используйте тег GeSHi ou la méthode des notes et avertissements pour afficher du code source ou des informations importantes.

Code source

Lorsque vous publiez un code source, vous devez appliquer la balise <syntaxhighlight>. Cela permettra à votre code de bénéficier d'une coloration syntaxique, le rendant plus lisible. Afin d'adapter la coloration au langage utilisé, ajoutez l'option lang="langage" dans la balise.

Пример Результат

<syntaxhighlight lang="php">
<?
     $hello = "Hello World";
     echo $hello; // comment
?>
</syntaxhighlight> 

<?
    $hello = "Hello World";
    echo $hello;         // comment
?>


Vous trouverez sur le site de l'extension GeSHi la liste des langages supportés et quelques options supplémentaires, telle l'ajout de numéros de ligne ou la mise en évidence d'une ligne dans le code.

Référence à une application

Lorsque vous mentionnez une application, préférez utiliser la capitalisation du site officiel. Si le site web n'est pas consistent, choisissez une forme et essayez de l'être dans votre article.
Par contre, ne capitalisez pas les noms de paquets ou des commandes, si ces derniers ne le sont pas.
Пример :

A MySQL database vs. the mysql command or the mysql-server package.



Listes

A chaque type de liste son utilisation.

Listes non-ordonnées

Ces listes sont utiles pour :

  • les prérequis
  • les checklists
Пример Результат 
* élément 1
* élément 2
  • élément 1
  • élément 2


Listes de définitions

Ces listes sont utiles pour :

  • les termes et explications
  • explications pour les variables dans une ligne de commande ou un fichier
Exemple Résultat 
;mot 1
: définition 1
;mot 2
: définition 2-1
: définition 2-2
mot 1
définition 1
mot 2
définition 2-1
définition 2-2


Listes ordonnées

Les listes ordonnées sont à utiliser avec parcimonie. Elles peuvent s'avérer pratiques pour lister l'ordre d'un processus, tel que le traitement d'une requête DNS.

Exemple Résultat 
# élément 1
# élément 2
  1. élément 1
  2. élément 2


Ces listes sont utiles pour :

  • décrire un processus de traitement

Dans certains cas, l’utilisation d'un tableau sera préférable aux listes.

Tableaux

Voici un exemple simple de tableau. Cela peut être utile pour présenter plus facilement un code exemple et son résultat. Les tableaux sont structurés comme suit.

{| début de tableau
|+ descriptif du contenu, optionnel; un seul par tableau positionné entre le début du tableau et la première ligne
|- début de ligne, optionnel sur la première ligne -- le moteur de wiki prend en charge la première ligne
! cellule entête, optionnel. Les entêtes peuvent être mises soit sur la même ligne séparées par des doubles points d'exclamations (!!), soit sur des lignes séparées, chacune ayant son unique point d'exclamation (!).
| cellule de donnée , requis! Les cellules de données consécutives d'un tableau peuvent être soit mises sur la même ligne séparées par une double barre verticale (||), soit sur des lignes séparées, chacune ayant son unique barre verticale (|).
|} fin de tableau


Exemple Résultat 
{|
|Оранжевый 
|Apple 
|-
|Хлеб 
|Пирог 
|-
|Масло 
|Мороженого  
|}
Orange Apple
Bread Pie
Butter Ice cream

Дополнительные сведения о таблицах, проконсультируйтесь Руководство Фонда Викимедиа

Сценарии и файлы

Убедитесь в том описать роль файлов или скриптов, которые вы упоминаете. Таким образом читатель будет иметь тот же уровень информации что вы и будут более способны понять ваш подход.

Скрипты

Когда вы даете содержимое сценария или файла конфигурации, убедитесь, что вы, он прокомментировал, предпочтительно на уровне соответствующих линий. Цель заключается, что читателю понять все действия, описанные, поэтому важно быть более образования как можно скорее. Таким образом он будет более возможность настраивать, обновлять или диагностировать проблемы с его сервером в долгосрочной перспективе.

Если файлы, которые вы размещаете частей длиной и /или не интересно для ваш учебник, вы можете пропустить эти стороны с эллипсом (...).
Мы рекомендуем использовать Balise GeSHi для отображения содержимого файлов или скриптов. Последний позволит вам, помимо подсветка синтаксиса, просто указать количество линий и выделить более важное значение. Рекомендуется использовать выделение для обозначения линии где есть изменения для выполнения.

Exemple Résultat 
<syntaxhighlight lang="apache" line start="10" highlight="5">
<VirtualHost *:80>
    DocumentRoot /www/example1
    ServerName www.example.com
    # Other directives here
</VirtualHost>
</syntaxhighlight>

10<VirtualHost *:80>
11    DocumentRoot /www/example1
12    ServerName www.example.com
13    # Other directives here
14</VirtualHost>


Файл

У вас есть возможность вставить файл или изображение в вашем руководстве. Самый простой способ достижения вещь является упомянуть документ в вашей статье, затем положить в Интернете один раз завершения записи. Если файл уже существует, он будет указано на красной ссылке. Нажав на эту ссылку, вы попадете на страницу, которая позволит вам загружать файл.

Exemple Résultat 
[[Media:mon_fichier.txt]]

Media:mon_fichier.txt

Стоит отметить, что ссылка на файл зависит исключительно от имени файла. Рекомендуется использовать имена, как описательный, как возможные файлы. Не забудьте включить описание файла, когда вы положить его в Интернете.

Изображения

Изображения обрабатываются как файлы. Поэтому можно включать их и поставить их в Интернете в так же, как файлы.
Единственная разница с файлом является, что изображение будет отображаться в тексте. Что дает вам больше вариантов для отображения.

Синтаксис для выполнения : 

[[File:sample_image.jpg|options|description]]

Параметры и описание являются обязательными.

Exemple Résultat 
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
  • 200px : размер для отображения
  • thumb : изображение подписан в обстановке, которая будет отображать описание
  • right : Выравнивание изображения справа
modèle image


Вы можете найти дополнительные сведения о различных параметрах, доступных на манипуляции изображения на MediaWiki руководство.
Избегайте слишком тяжелых изображений и предпочитают использовать форматы jpg, jpeg и png.

Клавиш клавиатуры

Чтобы описать клавиши клавиатуры, следуйте приведенным ниже рекомендациям :

  • записать их в верхнем регистре
  • utiliser la balise <span>
  • utiliser le symbole + si elles doivent être pressées simultanément
Exemple Résultat 
Поддержка на  <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">КЛАВИШИ ALT </span>+<span style="background-color: #E6E6E6;">SUPP</span> Затем  '''Диспетчер задач '''

Appuyer sur CTRL+ALT+SUPP puis Gestionnaire des tâches


Имена узлов

Мы рекомендуем вам использовать имена хостов наиболее конкретные возможности, что по отношению к роли сервера.
Exemple :

  • dns_serveur
  • bdd_master
  • proxy_nginx
  • и т.д.


Доменные имена

Когда вы имеете дело с доменными именами, предпочитают использовать поле Domain.TLD как домена по умолчанию. Если у вас есть несколько доменных имен упоминать, вы можете использовать имена, такие как домен - 1.TLD , домен - 2.TLD и т.д. | 

Для поддоменов, мы рекомендуем использовать имя в связи с ролью, к которому будет прикреплен Этот субдомен, как  master.Domaine.tld , slave.Domaine.tld , BDD.Domaine.tld и т.д. |



IP-адреса

Чтобы избежать, чтобы раскрыть ваш IP в ваши учебники и быть как можно более четкими, мы приглашаем вас встретиться Зарезервированные адреса в документации. В нашем случае, мы предпочитаем использовать блок адреса 203.0.113.0/24 за все, что публичный адрес. Либо 203.0.113.0 à 203.0.113.255.

Для адреса локальных сетей и localhost вы можете сохранить IP, который вы обычно используете. Это означает :

  • 10.0.0.0/8 - 10.0.0.0 – 10.255.255.255
  • 172.16.0.0/12 - 172.16.0.0 – 172.31.255.255
  • 192.168.0.0/16 - 192.168.0.0 – 192.168.255.255
  • 127.0.0.0/8 - 127.0.0.0 – 127.255.255.255



Ссылки

Créer un lien

Скриншоты

Если ваш учебник описывает действия для реализации на графический интерфейс, то лучше включить снимки экрана, чтобы сделать его более четким. Будьте осторожны, однако не быть слишком. Это не вопрос того, скриншот для каждой кнопки, текст или ссылки, но только то, что он принимает для успешной езды следовать за вами.
Если вы хотите захватить выделить элементы, пожалуйста, не стесняйтесь добавить стрелки или фреймы в точку. Это только будет только всеобъемлющий учебник.

Мы рекомендуем поместить элементы, вы упоминаете в жир и которые находятся в графический интерфейс, что это кнопки, ссылки, checkbox, и т.д. | 

Не забудьте добавить описание, когда вы поворачиваете изображения онлайн.



Вывод

Пожалуйста, Включите краткое заключение к ваш учебник, который будет суммировать то, что было сделано и представить, что может быть сделано позднее.
У вас есть все, что вам нужно для создания ваших собственных статей ! Кроме того, вы также можете проконсультироваться нашу статью о стиль iKoulaи хорошо писать !


Эта статья представляется вам быть полезным ?

0



Вы не можете оставлять комментарии.

Источник — https://ru-wiki.ikoula.com/index.php?title=Как_формат_статьи&oldid=2869