База знаний

Добавление сниппетов кода

ID статьи: 411
Последнее обновление: 20 июн., 2019

Существует возможность добавить примеры кода или сниппеты (фрагменты) к статьям базы знаний, чтобы помочь пользователю добиться определенного результата или решить распространенную проблему. В KBPublisher функция доступна благодаря тегам форматирования, которые можно использовать для добавления примера кода. Когда пользователь открывает статью для просмотра, то в тексте отображается пример кода. Код отформатирован в соответствии с указанным вами языком кодирования и оформлен в отдельном поле, внешне напоминающий редактор кода для этого языка.

Существует два способа добавления сниппета кода в статью.

Вариант 1: Кнопка на панели инструментов

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

  1. Откройте статью для редактирования.
  2. Поместите курсор в место, где будет отображаться сниппет кода. Вы можете переместить фрагмент позже, если потребуется.
  3. Нажмите кнопку (Вставить сниппет), расположенную на панели инструментов редактора.
  4. В открывшемся окне выберите язык и добавьте содержимое кода.
  5. Сохраните изменения, нажав кнопку ОК.

Пример:

<?php 
$value = 'something from somewhere';
setcookie("TestCookie", $value);
setcookie("TestCookie", $value, time()+3600);  /* expire in 1 hour */
setcookie("TestCookie", $value, time()+3600, "/~rasmus/", "example.com", 1);
?>

Доступные языки

В выпадающем списке выбора языка кодирования доступны следующие варианты:

  • Apache
  • Bash
  • CoffeeScript
  • C++
  • C#
  • CSS
  • Diff
  • HTML
  • HTTP
  • INI
  • Java
  • JavaScript
  • JSON
  • Makefile
  • Markdown
  • Nginx
  • Objective-C
  • Perl
  • PHP
  • Python
  • Ruby
  • SQL
  • VBScript
  • XHTML
  • XML

Вариант 2: Тег [code]

Чтобы добавить сниппеты кода в статью с помощью тега [code]:

  1. Откройте статью для редактирования.
  2. В начале сниппета кода добавьте открывающий тег, а в конце ‒ закрывающий:
    [code=XXX] Здесь добавьте свой код. [/code]
  3. Замените XXX индикатором языка кодирования сниппета. Список индикаторов приведен ниже.
  4. Вставьте свой код между открывающим и закрывающим тегами.
  5. Убедитесь в корректности отображения кода в статье, выполнив предварительный просмотр.

Пример:

<?php 
$value = 'что-то откуда-то';
setcookie("TestCookie", $value);
setcookie("TestCookie", $value, time()+3600);  /* expire in 1 hour */
setcookie("TestCookie", $value, time()+3600, "/~rasmus/", "example.com", 1);
?>

Доступные языки

В таблице ниже найдите язык кодирования вашего сниппета и используйте соответствующий индикатор языка.

Язык кода Индикатор
AS3
  • actionscript3
  • as3
Bash
  • bash
  • shell
CSharp
  • c-sharp
  • csharp
ColdFusion
  • cf
  • coldfusion
Cpp
  • c
  • cpp
Css
  • css
Delphi
  • delphi
  • pas
  • pascal
Diff
  • diff
  • patch
Erlang
  • erl
  • erlang
Groovy
  • groovy
JScript
  • javascript
  • js
  • jscript
Java
  • java
JavaFX
  • javafx
  • jfx
Perl
  • perl
  • pl
Php
  • php
Plain
  • plain
  • text
PowerShell
  • powershell
  • ps
Python
  • py
  • python
Ruby
  • rails
  • ror
  • ruby
Scala
  • scala
Sql
  • sql
Vb
  • vb
  • vbnet
Xml
  • html
  • xhtml
  • xml
  • xslt
Эта статья была:   Полезна | Не полезна
ID статьи: 411
Последнее обновление: 20 июн., 2019
Ревизия: 4
Доступ: Открытый доступ
Просмотры: 868
Комментарии: 0