Available translations
loading results
Definition Pages
Summary: A definition page, also known as Docs Node Page, is the page that describes what a node is or represents in any given hierarchy, how it works, and how it interacts with other nodes. It's the page users access when clicking the help (?) button on a node's menu.
Summary: Страница определения, также известная как Docs Node Page, - это страница, которая описывает, чем является узел или что он представляет собой в данной иерархии, как он работает и как взаимодействует с другими узлами. Это страница, на которую пользователи попадают, нажав кнопку помощи (?) в меню узла.
Summary: Eine Definitionsseite, auch bekannt als Docs Node Page, ist die Seite, die beschreibt, was ein Knoten in einer bestimmten Hierarchie ist oder darstellt, wie er funktioniert und wie er mit anderen Knoten interagiert. Es ist die Seite, auf die Benutzer zugreifen, wenn sie im Menü eines Knotens auf die Schaltfläche Hilfe (?) klicken.
This page is the main source of information about the particular node. Think of definition pages as the place where people should find all the details about the behavior of the node, including its configuration.
Эта страница является основным источником информации о конкретном узле. Считайте страницы определения местом, где люди должны найти все подробности о поведении узла, включая его конфигурацию.
Diese Seite ist die Hauptquelle für Informationen über den jeweiligen Knoten. Betrachten Sie die Definitionsseiten als den Ort, an dem die Benutzer alle Einzelheiten über das Verhalten des Knotens, einschließlich seiner Konfiguration, finden sollten.
Foundations->Topic->Docs Node Page->Content
A Docs Node Page features:
Eine Docs Node Page hat folgende Eigenschaften:
Функции Docs Node Page:
Dokümanlar Düğüm Sayfası özellikleri:
- Definition: a short description of what the node is, and what it represents in the hierarchy. The definition is displayed to the left of the node's icon.
- Определение: краткое описание того, что представляет собой узел и что он представляет в иерархии. Определение отображается слева от значка узла.
- Definition: Düğümün ne olduğu ve hiyerarşide neyi temsil ettiğinin kısa bir açıklaması. Tanım, düğüm simgesinin solunda görüntülenir.
- Content: all the information relative to the node in terms of how the node is used, how it affects operations, or how it relates to other nodes.
- Содержимое: вся информация, относящаяся к узлу, с точки зрения того, как узел используется, как он влияет на операции или как он относится к другим узлам.
- Content: Düğümün nasıl kullanıldığı, işlemleri nasıl etkilediği veya diğer düğümlerle nasıl ilişkili olduğu açısından düğüme ilişkin tüm bilgiler.
- Configuration: a section describing the elements of the node's configuration file.
- Configuration: ein Abschnitt, der die Elemente der Konfigurationsdatei der Node beschreibt.
- Конфигурация: раздел, описывающий элементы файла конфигурации узла.
- Configuration: Düğümün yapılandırma dosyasının öğelerini açıklayan bölüm.
- Auto-generated content: information extracted from the system, workspace, etc., to provide the technical context in which the node exists.
- Auto-generated content: Informationen, die aus dem system, dem workspace usw. extrahiert werden, um den technischen Kontext zu liefern, in dem die Node existiert.
- Автоматически сгенерированный контент: информация, извлеченная из системы, рабочего пространства и т.д., для обеспечения технического контекста, в котором существует узел.
- Auto-generated content: Düğümün bulunduğu teknik bağlamı sağlamak için sistemden, çalışma alanından vb. çıkarılan bilgiler.
Definition Box
Поле определения
The definition box is the top paragraph on a definition page, rendered to the right of the icon representing the node, in bold.
Поле определения - это верхний абзац на странице определения, отображаемый справа от иконки, представляющей узел, выделенный жирным шрифтом.
Das Definitionsfeld ist der oberste Absatz auf einer Definitionsseite, der rechts neben dem Symbol, das den Knoten darstellt, in Fettdruck dargestellt wird.
Note: Always have in mind that this paragraph is the one used to build tooltips throughout the Docs. It is the contextual information people gets about the node when you write the Node Type throughout the Docs.
Note: Всегда помните, что этот параграф используется для построения всплывающих подсказок во всех документах. Это контекстная информация, которую люди получают об узле, когда вы пишете тип узла во всех документах.
Note: Denken Sie immer daran, dass dieser Absatz für die Erstellung von Tooltips in der gesamten Dokumentation verwendet wird. Es ist die kontextuelle Information, die man über den Knoten erhält, wenn man den Knotentyp (Node Type) in den Docs schreibt.
Use this space to write a concise, accurate, and careful description of WHAT the node is or represents. As part of this definition, you may include WHAT the node is used for, as it is the use of the node that determines what it is or represents in the first place.
Используйте это место, чтобы написать краткое, точное и тщательное описание того, ЧЕМ является или что представляет собой узел. В качестве части этого определения вы можете указать, для чего используется узел, поскольку именно использование узла определяет, что он представляет собой или представляет в первую очередь.
Verwenden Sie diesen Platz, um eine kurze, genaue und sorgfältige Beschreibung dessen zu verfassen, WAS der Knoten ist oder darstellt. Als Teil dieser Definition können Sie auch angeben, Wofür der Knoten verwendet wird, da die Verwendung des Knotens bestimmt, was er in erster Linie ist oder darstellt.
Do not include any other type of information in the definition box. Do not explain how to use the node, how the system uses the node, or how the node interacts with other nodes. The definition box must answer the WHAT question, and nothing else.
Не включайте в поле определения никакой другой тип информации. Не объясняйте, как использовать узел, как система использует узел или как узел взаимодействует с другими узлами. Поле определения должно отвечать на вопрос ЧТО, и ничего больше.
Fügen Sie keine anderen Informationen in das Definitionsfeld ein. Erläutern Sie nicht, wie der Knoten zu verwenden ist, wie das System den Knoten verwendet oder wie der Knoten mit anderen Knoten interagiert. Das Definitionsfeld muss die WAS-Frage beantworten, und nichts anderes.
Tip: Keep the definition box to a sentence or two whenever possible. Long definitions make cumbersome tooltips and are hard to read in bold.
Tip: По возможности ограничивайте поле определения одним-двумя предложениями. Длинные определения делают всплывающие подсказки громоздкими и трудночитаемыми при выделении жирным шрифтом.
Tip: Beschränken Sie das Definitionsfeld nach Möglichkeit auf einen oder zwei Sätze. Lange Definitionen machen Tooltips umständlich und sind in Fettschrift schwer zu lesen.
Using Blocks and Includes
Использование блоков и элементов
Verwendung von Blöcken und Einbindungen
The rest of the definition page is organized in blocks.
Остальная часть страницы определения организована в виде блоков.
Der Rest der Definitionsseite ist in Blöcken organisiert.
We build pages using blocks so that we may later include blocks of content on other pages. This concept of blocks and includes is crucial to avoid duplicating content. When writing a Topic page, you will many times want to refer to content that exists on another page. If that piece of content is set up as a block, then you may include it.
Мы создаем страницы с помощью блоков, чтобы впоследствии включить блоки контента на других страницах. Эта концепция блоков и дополнений очень важна для того, чтобы избежать дублирования контента. При написании тематической страницы вы часто захотите сослаться на контент, существующий на другой странице. Если этот фрагмент контента установлен как блок, то вы можете подключить его.
Wir bauen Seiten mit Blöcken auf, damit wir später Inhaltsblöcke auf anderen Seiten einfügen können. Dieses Konzept der Blöcke und Einbindungen ist wichtig, um doppelte Inhalte zu vermeiden. Wenn Sie eine Themenseite schreiben, werden Sie oft auf Inhalte verweisen wollen, die auf einer anderen Seite vorhanden sind. Wenn dieser Inhalt als Block angelegt ist, können Sie ihn einbinden.
And this is the perfect example! I need to explain how to create blocks, but instead of writing the whole thing, I will include content from the Docs Block Style page.
И это идеальный пример! Мне нужно объяснить, как создавать блоки, но вместо того, чтобы писать все это, я включу содержание со страницы Docs Block Style.
Ein gutes Beispiel! Ich werde erläutern, wie man Blöcke erstellt, aber anstatt das Ganze zu schreiben, werde ich Inhalte von der Seite Docs Block Style einfügen.
Tip: Notice the faint quotation marks on the right-hand side of the page right after this paragraph. The quotes represent the point in which a block of content is included on the page. Triple-click to the left of quotes to select/highlight the include command that references the block of content I'm including.
Tip: Обратите внимание на тусклые кавычки на правой стороне страницы сразу после этого абзаца. Кавычки представляют собой точку, в которой блок содержимого включается на страницу. Тройным щелчком слева от кавычек выберите/выделите команду include, которая ссылается на блок содержимого, который я подключил.
Tip: Beachten Sie die schwachen Anführungszeichen am rechten Rand der Seite direkt nach diesem Absatz. Die Anführungszeichen stehen für den Punkt, an dem ein Inhaltsblock auf der Seite eingefügt wird. Klicken Sie dreimal auf die linke Seite der Anführungszeichen, um den Einfügebefehl auszuwählen bzw. hervorzuheben, der auf den eingefügten Inhaltsblock verweist.
Foundations->Topic->Docs Block Style->Definition
Use block paragraphs to define blocks of content with any number of paragraphs. A block starts with the paragraph that is assigned the Docs Block Style and ends on the last paragraph before the next paragraph with a Docs Block Style, or where the page ends.
Blockabsätze definieren eine Reihe von Absätzen, die von anderen Seiten aus eingefügt werden können. Wenn Sie einen Block einbinden, indem Sie einen Docs Include Style Absatz erstellen, müssen Sie auf einen Blockabsatz verweisen, der auf der Seite erstellt wurde, die die einzubindende Absatzgruppe enthält. Ein Block enthält alle Absätze nach sich selbst bis zum nächsten Block oder dem Ende der Seite. Warning!!! This translation is outdated. English version is... Use block paragraphs to define blocks of content with any number of paragraphs. A block starts with the paragraph that is assigned the Docs Block Style and ends on the last paragraph before the next paragraph with a Docs Block Style, or where the page ends. Please update this translation.
Используйте блочные абзацы для определения блоков содержимого с любым количеством абзацев. Блок начинается с абзаца, которому присвоен стиль Docs Block Style, и заканчивается последним абзацем перед следующим абзацем со стилем Docs Block Style или местом окончания страницы.
İstediğiniz sayıda paragraf içeren içerik bloklarını tanımlamak için paragrafları engelle'yi kullanın. Blok, Dokümanlar Blok Stiline atanan paragrafla başlar ve Dokümanlar Blok Stiliyle sonraki paragraftan önceki son paragrafta veya sayfanın bittiği yerde sona erer.
Foundations->Topic->Docs Block Style->Content
To start a new block, write the name of the block in a new paragraph and apply the Docs Block Style.
Чтобы начать новый блок, напишите название блока в новом абзаце и примените стиль Docs Block Style.
Yeni bir blok başlatmak için bloğun adını yeni bir paragrafa yazın ve Dokümanlar Blok Stilini uygulayın.
Once you apply the Docs Block Style, the paragraph seems to disappear. It doesn't though. What happens is that the paragraph gets assigned a CSS style that makes invisible the name you wrote, and displays a faint triangle pointing downwards that is highlighted upon mouseover. The triangle now marks the start of the block.
После применения стиля Docs Block Style абзац, кажется, исчезает. Однако это не так. Происходит следующее: абзацу присваивается стиль CSS, который делает невидимым написанное вами название и отображает слабый треугольник, направленный вниз, который подсвечивается при наведении курсора мыши. Треугольник теперь обозначает начало блока.
Dokümanlar Blok Stilini uyguladıktan sonra paragraf kayboluyor gibi görünüyor. Ama değil. Olan şey, paragrafa yazdığınız adı görünmez kılan bir CSS stili atanması ve fare imlecinin üzerine getirildiğinde vurgulanan aşağı doğru işaret eden soluk bir üçgen göstermesidir. Üçgen şimdi bloğun başlangıcını işaret ediyor.
To end a block, create a new block after it. If you don't, then the block ends wherever the page ends.
Чтобы завершить блок, создайте после него новый блок. Если этого не сделать, то блок закончится там, где закончится страница.
Bir bloğu sonlandırmak için, ondan sonra yeni bir blok oluşturun. Bunu yapmazsanız, blok sayfanın bittiği yerde sona erer.
Note: Everything above this paragraph belongs to the Docs Block Style page, in particular, to the Definition and Content blocks. Notice how you can't edit the paragraph above. To edit the content that is included in a page, you must edit the source, not the included block.
Note: Все, что находится выше этого абзаца, относится к странице Docs Block Style, в частности, к блокам Definition и Content. Обратите внимание, что вы не можете редактировать абзац выше. Для редактирования содержимого, включенного в страницу, необходимо редактировать источник, а не подключенный блок.
Note: Alles oberhalb dieses Absatzes gehört zur Seite Dokumentationsblockstil (Docs Block Style), insbesondere zu den Blöcken Definition und Inhalt. Beachten Sie, dass Sie den Absatz darüber nicht bearbeiten können. Um den in einer Seite enthaltenen Inhalt zu bearbeiten, müssen Sie die Quelle bearbeiten, nicht den enthaltenen Block.
Warning: You will seldom need to include blocks of content in definition pages. I explained the concept of includes at this point because it helps understand the concept of blocks. You will certainly use blocks in definition pages, but you will not use includes. This is because definition pages refer solely to the node in question and shouldn't include any other kind of information that is not intimately tied to the node itself.
Warning: Вам редко придется вставлять блоки содержимого в страницы определения. Я объяснил концепцию include на этом этапе, потому что она помогает понять концепцию блоков. Вы, конечно, будете использовать блоки на страницах определения, но не будете использовать подлючения. Это связано с тем, что страницы определения относятся исключительно к рассматриваемому узлу и не должны содержать никакой другой информации, не связанной тесно с самим узлом.
Warning: Sie werden nur selten Inhaltsblöcke in Definitionsseiten einfügen müssen. Ich habe das Konzept der Einbindungen an dieser Stelle erklärt, weil es hilft, das Konzept der Blöcke zu verstehen. Sie werden sicherlich Blöcke in Definitionsseiten verwenden, aber Sie werden keine Einbindungen verwenden. Das liegt daran, dass sich Definitionsseiten ausschließlich auf den betreffenden Knoten beziehen und keine anderen Informationen enthalten sollten, die nicht eng mit dem Knoten selbst verbunden sind.
Content Block
Блок контента
Blockinhalt
All definition pages must have a Content block. In fact, the first paragraph on the page must be the block definition.
Все страницы определений должны иметь блок Content. Фактически, первый абзац на странице должен быть определением блока.
Alle Definitionsseiten müssen einen Inhaltsblock enthalten. Tatsächlich muss der erste Absatz auf der Seite die Blockdefinition sein.
Let's try with an example right here!
Давайте попробуем на примере прямо здесь!
Versuchen wir es gleich hier mit einem Beispiel!
Note: Notice that the paragraph right after this Note and before the green callout paragraph is the definition of a block named Content. You know there is a block because you can see the triangle turning black when you hover the mouse pointer below this box. You can see the block is called Content if you triple-click on the left of the triangle.
Note: Обратите внимание, что абзац сразу после этого примечания и перед зеленым абзацем с призывом - это определение блока с именем Content. Вы знаете, что здесь есть блок, потому что видите, как треугольник становится черным, когда вы наводите указатель мыши под этим блоком. Вы можете увидеть, что блок называется Content, если сделаете тройной щелчок слева от треугольника.
Note: Beachten Sie, dass der Absatz direkt nach diesem Hinweis und vor dem grünen Callout-Absatz die Definition eines Blocks namens Inhalt ist. Sie wissen, dass es einen Block gibt, weil sich das Dreieck schwarz färbt, wenn Sie mit dem Mauszeiger unter dieses Feld fahren. Sie können sehen, dass der Block "Inhalt" heißt, wenn Sie links neben dem Dreieck dreimal klicken.
Content
The content block is where you explain HOW the node works. This is where you explain how the system uses the node, how the node interacts with other nodes, and how users may use the node.
Im Inhaltsblock erklären Sie, WIE der Knoten funktioniert. Hier erklären Sie, wie das System den Knoten verwendet, wie der Knoten mit anderen Knoten interagiert und wie Benutzer den Knoten verwenden können.
Tip: This is a good opportunity to go to any node in one of the well-known and properly documented hierarchies, click on the help button on the menu, and analyze how the definition page is structured! Try, for instance, the LAN Network Node. Notice that the page has two blocks: Content and Configuring!
Tip: Это хорошая возможность перейти к любому узлу в одной из известных и правильно документированных иерархий, нажать кнопку помощи в меню и проанализировать, как структурирована страница определения! Попробуйте, например, узел LAN Network. Обратите внимание, что страница состоит из двух блоков: Content и Configuring!
Tip: Dies ist eine gute Gelegenheit, zu einem beliebigen Knoten in einer der bekannten und gut dokumentierten Hierarchien zu gehen, auf die Hilfe-Schaltfläche im Menü zu klicken und zu analysieren, wie die Definitionsseite aufgebaut ist! Versuchen Sie es zum Beispiel mit dem LAN-Netzwerkknoten (LAN Network Node). Beachten Sie, dass die Seite zwei Blöcke hat: Inhalt und Konfigurieren!
Configuring Block
Блок Configuring
Block konfigurieren
This block may or not be required, depending on the node. If the node has a configuration, then we use the Configuring block to explain each property.
Этот блок может потребоваться или не потребоваться в зависимости от узла. Если узел имеет конфигурацию, то мы используем блок Configuring для объяснения каждого свойства.
Dieser Block kann je nach Knoten erforderlich sein oder nicht. Wenn der Knoten eine Konfiguration hat, dann verwenden wir den Block Configuring, um jede Eigenschaft zu erklären.
Take a look at the LAN Network Node page for an example.
В качестве примера посмотрите на страницу LAN Network Node.
Ein Beispiel dafür finden Sie auf der Seite LAN-Netzwerkknoten (LAN Network Node).
Notice that after the definition of the block, we write the title of the section as follows:
Обратите внимание, что после определения блока мы пишем заголовок раздела следующим образом:
Beachten Sie, dass wir nach der Definition des Blocks den Titel des Abschnitts schreiben:
Node Type + Configuration
Following the earlier example, that would be:
Следуя предыдущему примеру, это будет:
In Anlehnung an das vorangegangene Beispiel wäre dies der Fall:
LAN Network Node Configuration
We use a title to separate the two sections or blocks on the page, pretty much in the same way we use titles elsewhere. Notice that the title must be inside the Configuring block so that the title is included as well if we ever wish to include this block on another page.
Мы используем заголовок для разделения двух разделов или блоков на странице, практически так же, как мы используем заголовки в других местах. Обратите внимание, что заголовок должен находиться внутри блока Configuring, чтобы заголовок был включен, если мы захотим включить этот блок на другой странице.
Wir verwenden einen Titel, um die beiden Abschnitte oder Blöcke auf der Seite zu trennen, so wie wir auch sonst Titel verwenden. Beachten Sie, dass der Titel innerhalb des Configuring-Blocks stehen muss, damit der Titel auch enthalten ist, wenn wir diesen Block auf einer anderen Seite einfügen wollen.
Also notice that we don't use a title after the definition of the Content block. It is simply unnecessary, and the page reads better without one.
Также обратите внимание, что мы не используем заголовок после определения блока Content. Он просто не нужен, и страница лучше читается без него.
Beachten Sie auch, dass wir nach der Definition des Inhaltsblocks keinen Titel verwenden. Er ist einfach unnötig, und die Seite liest sich ohne ihn besser.
Auto-generated Information
Автоматически генерируемая информация
Automatisch generierte Informationen
Wherever the content you write ends, the system includes several automatically-generated sections. Take a look at this type of content just so that you notice that you don't need to manually include in your writeups any of the details the system generates automatically.
Там, где заканчивается написанный вами контент, система включает несколько автоматически сгенерированных разделов. Посмотрите на этот тип контента, чтобы вы заметили, что вам не нужно вручную включать в свои записи какие-либо детали, которые система генерирует автоматически.
An den Stellen, an denen der von Ihnen geschriebene Inhalt endet, fügt das System mehrere automatisch generierte Abschnitte ein. Werfen Sie einen Blick auf diese Art von Inhalt, damit Sie sehen, dass Sie keine der vom System automatisch generierten Details manuell in Ihre Texte einfügen müssen.