Skip to content
This repository was archived by the owner on Jun 5, 2018. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Welcome to the docs repo for the Stingray interactive component
# Добро пожаловать в реппозиторий документации по Stingray interactive component

This repository hosts all the source files that are used to build public-facing documentation for Stingray, and for the products that ship with Stingray as an interactive component (currently 3ds Max Interactive and Maya Interactive).
В этом репозитории хранятся все исходные файлы, которые используются для создания публичной документации для Stingray, а также для продуктов, которые поставляются с Stingray в качестве interactive component (cВ данный момент 3ds Max Interactive и Maya Interactive).

This readme is intended to orient internal Autodesk developers and external customers to our help and docs systems.
Этот readme предназначен для ориентации внутренних разработчиков Autodesk и внешних клиентов на нашу помощь и документы.

# Viewing the docs
# Просмотр документации

If you just want to read the docs, it's best to use the public docs site, at:
Если вы только хотите читать документацию, то лучше это делать на специальном публичном сайте документации:

<http://www.autodesk.com/stingray-help>

You'll have access there to all the Stingray material in its final format as viewed by customers, including the API references. The content in this public site always corresponds to the last released version of Stingray, and typically matches the content of the `master` branch in this `stingray-docs` repository.
У вас будет доступ ко всему материалу Stingray в его окончательном формате, если он будет рассмотрен клиентами, включая руководство API. Содержимое этого общедоступного сайта всегда соответствует последней выпущенной версии Stingray и обычно соответствует содержимому ветки `master` в этом репозитории` stingray-docs`

The best way to find out if something is documented in the Stingray Help for the current release is to search the site above.

Expand All @@ -36,7 +36,7 @@ What this means is that when you submit a pull request to our public GitHub repo

## Using GitHub for external customers

If you're not already familiar with using GitHub to contribute to open-source projects, there are lots of primers [like this one](https://guides.github.com/) out there on the Internet. There are also lots of tools that can help make it easier, like [Sourcetree](https://www.sourcetreeapp.com/), [GitKraken](https://www.gitkraken.com/), [GitHub Desktop](https://desktop.github.com/), etc.
Если вы еще не знакомы с использованием GitHub внести вклад в проекты с открытым исходным кодом, есть много праймеров [like this one](https://guides.github.com/) out there on the Internet. There are also lots of tools that can help make it easier, like [Sourcetree](https://www.sourcetreeapp.com/), [GitKraken](https://www.gitkraken.com/), [GitHub Desktop](https://desktop.github.com/), etc.

You submit modifications to us using *pull requests* -- the mechanism GitHub uses to exchange, review and accept changes to a repo from other users. Here's a couple of different ways you can go about proposing changes to us through a pull request:

Expand All @@ -46,9 +46,9 @@ You submit modifications to us using *pull requests* -- the mechanism GitHub use

## Source organization

Source files for these parts of the doc are all maintained in the *source/interactive_help* folder. The organization of the files in this folder more or less matches the organization of the final TOC shown on the public docs site, so it should be pretty easy to figure out where to make your edits and additions.
Исходные файлы для этих частей документа поддерживаются в папке *source/interactive_help* . Организация файлов в этой папке более или менее соответствует организации окончательного ТОС, отображаемого на сайте публичных документов, поэтому довольно легко понять, где можно внести изменения и дополнения.

**NOTE:** This repo also has a couple of *submodules* that point to other repositories. Currently these submodules are hidden away in our private GitHub cloud, so you can't access them. If you're working in the public mirror, you might occasionally run into errors when cloning or pulling from this repo, telling you that the submodules can't be found. Don't worry about it, that's expected! If the errors are getting in the way though, you might be able to avoid these errors by configuring your Git client not to *recurse* into submodules.
**NOTE:** В этом репо также есть пара *submodules* это указывает на другие репозитории. В настоящее время эти подмодули скрыты в наших частных GitHub облако, so you can't access them. If you're working in the public mirror, you might occasionally run into errors when cloning or pulling from this repo, telling you that the submodules can't be found. Don't worry about it, that's expected! If the errors are getting in the way though, you might be able to avoid these errors by configuring your Git client not to *recurse* into submodules.

## File format

Expand All @@ -62,13 +62,13 @@ Many good text editors can give you previews of what the Markdown format will lo

As a general rule, if the GitHub preview looks good, you can be pretty sure that your content will be formatted correctly in the final build.

## Using conditions to make text appear for different "flavors"
## Использование условий для создания текста для разных "flavors"

The source material in this repo is used to build customer-facing help for Stingray, 3ds Max Interactive, and Maya Interactive. Although these different flavors are based on the same core interactive component, they are specialized and tweaked by using different build configurations and shipping with different sets of default plug-ins. So, sometimes the help content that accompanies the flavors will need to be different too.
Исходный материал в этом репо используется для создания справки, ориентированной на клиента для Stingray, 3ds Max Interactive, и Maya Interactive. Хотя эти различные вариации основаны на одном и том же ключевом интерактивном компоненте, они специализируются и настраиваются с использованием различных конфигураций сборки и доставки с различными наборами плагинов по умолчанию. So, sometimes the help content that accompanies the flavors will need to be different too.

There are two ways to change things up for different flavors: variables, and conditions.

Variables are simple text keys that get replaced automatically during the doc build process by new strings that reflect the flavor being built. You can tell a variable by the syntax `{{ variable_name }}`, with two curly-brackets around the variable name. For example, if you write, `Welcome to {{ ProductName }}, the greatest software in history`, that text will be rendered as `Welcome to Stingray, the greatest software in history` or `Welcome to 3ds Max Interactive, the greatest software in history` depending on the flavor you choose to build.
Переменные - это простые текстовые ключи, которые автоматически заменяются во время процесса сборки doc новыми строками, которые отражают создаваемый вариант. Вы можете указать переменную синтаксисом `{{ variable_name }}`, with two curly-brackets around the variable name. For example, if you write, `Welcome to {{ ProductName }}, the greatest software in history`, that text will be rendered as `Welcome to Stingray, the greatest software in history` or `Welcome to 3ds Max Interactive, the greatest software in history` depending on the flavor you choose to build.

Conditional text means including or excluding a block of text or an entire topic based on whether certain flags are active. For example, if a certain paragraph only applies to 3ds Max Interactive, you could write:

Expand Down Expand Up @@ -155,24 +155,24 @@ Sometimes, especially for software versions, you'll see places where the Markdow

The following sections are intended only for people with access to the internal version of this source repository. Our build tools are still private for the moment. And the content in the reference docs is pulled from comments in the engine source, so it's also private. (But if you spot an error or a problem in the reference docs, don't hesitate to tell us about it -- see above!)

## Building the docs
## Сборка документации

1. Install [Ruby](https://www.ruby-lang.org/en/downloads/), if you don't have it already.
1. Установите [Ruby](https://www.ruby-lang.org/en/downloads/), если у вас его нетy.

2. Install [Git](https://git-scm.com/download/win), if you don't have it already. The build process will run `git status` to find the current branch your content is tracking, so make sure that the `Path` environment variable for your system contains the location of your Git binaries. For example, `C:\Program Files (x86)\Git\bin`.
2. Установите [Git](https://git-scm.com/download/win), если его у вас еще нет. В процесс сборки будет запущен `git status` для поиска текущей ветку вашего контента, так что убедитесь что переменная окружения `Path` вашей системы содержит положение вашего Git binaries. Пример, `C:\Program Files (x86)\Git\bin`.

3. If you're building the main Stingray Help, which includes the reference docs, you'll need the MSBuild tools for Visual Studio 2015, available [here](
3. Если вы собираете главный хелп Stingray, который включает reference docs, вам понадобиться MSBuild инструмент для Visual Studio 2015, доступный [здесь](
https://www.microsoft.com/en-us/download/details.aspx?id=48159).

4. Install [Lua for Windows](http://files.luaforge.net/releases/luaforwindows/luaforwindows), and make sure that the `Path` environment variable for your system contains the location of `lua.exe`. For example, `C:\Program Files (x86)\Lua\5.1`.
4. Установите [Lua for Windows](http://files.luaforge.net/releases/luaforwindows/luaforwindows), и убедитесь, что `Path` переменная среды окружения содержит путь к `lua.exe`. Например, `C:\Program Files (x86)\Lua\5.1`.

5. Make sure that you have fully cloned this repo *and* its submodules. You should have a `build/ixg-doc-tools` folder full of stuff, and a `stingray-engine` folder full of stuff.
5. Убедитесь, что вы полностью клонировали это репо *и* его подмодули. У вас должна быть папка `build/ixg-doc-tools` со всем необходимым, и заполненая папка `stingray-engine`.

6. Go to the `build` folder, and look for the Ruby scripts. You'll find three convenient `make_....rb` files for building the main help in each of its flavors: Stingray, Max Interactive and Maya Interactive.
6. Перейдите в папку `build`, и найдите скрипт Ruby. Вы найдете три удобных файла `make_....rb` для сборки хелпа main для каждого вида: Stingray, Max Interactive и Maya Interactive.

By default, you'll get a local build, which is placed in the `output` folder. You can also have it upload to the public Autodesk Knowledge Network (AKN) site on the cloud.
По умолчанию вы получите локальную сборку, которая помещается в папку `output` . Вы также можете загрузить его для публики Autodesk Knowledge Network (AKN) site on the cloud.

### Build settings
### Настройки сборки

The build process for each flavor of the help is controlled by variables in the Ruby script file, and configuration files that you'll find in the `config` folder. You can modify these files to change how the docs are generated and where they end up. For more information on the settings in the .xml files, see the readme `.docx` file in the `build/ixg-doc-tools/tools` folder.

Expand Down Expand Up @@ -208,16 +208,16 @@ Submodules don't "advance" automatically; we have to specifically set them every

### Release workflow

The overall release workflow is this:
Общий рабочий процесс выпуска - такой:

- We work in our `develop` branch on new features as they get done in the engine's `develop` branch.
- Мы работаем в нашей ветви `develop` над новыми фичами по мере их разработки в `develop` ветви.

- When the engine branches for a release, we create a corresponding `release` branch and start working on release-specific content in there.
- Для релизной ветви движка, мы создаем соответствующую ветвь `release` и начать работу над содержимым, специфичным для этого редиза.

- Every sprint:

- we merge our `release` branch back into our `develop` branch.
- мы мержим `release` ветвь обратно в нашу ветвь `develop` .

- we update the submodules for our `develop` and `release` branches to point to the most recent commits.
- мы обновляем подмодули для наших `develop` и `release` ветви, чтобы указать на последние коммиты.

- When the release goes FCD and we want to publish the help, we merge our `release` branch into `master`, and update its submodule to point to the newest `master` of the Stingray engine.
10 changes: 5 additions & 5 deletions source/interactive_help/about_3ds_max_interactive.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# About 3ds Max Interactive
# О 3ds Max Interactive

3ds Max Interactive helps you produce visually stunning, immersive, and interactive experiences of every kind.
3ds Max Interactive помогает создавать визуально ошеломляющие, захватывающие и интерактивные впечатления любого рода.

It includes a real-time engine that you'll use to experience your 3D content on multiple platforms -- including desktop, mobile devices, game consoles, over the Web, and on virtual reality and augmented reality (VR & AR) devices. With the accompanying set of editing tools, you can build up your scenes and make them come to life with interactive behaviors and visual effects.
Он включает движок реального времени который вы можете использовать для вашего 3D контента на множестве платформ -- включая desktop, мобильные устройства, игровые консоли, Web, и виртуальную и устройства виртуальной и расширенной реальности (VR & AR). С помощью прилагаемого набора инструментов для редактирования вы можете создавать свои сцены и воплощать их в жизнь с интерактивным поведением и визуальными эффектами.

By combining the powerful 3D modeling and animation tools of 3ds Max with these new tools for authoring interactive experiences, 3ds Max Interactive aims to give you simple, efficient, and familiar workflows for creating engaging content.
Комбинируя мощные средства 3D моделирования и нимации в 3ds Max с этим новым инструментом для создания интерактивного контента, 3ds Max Interactive старается быть простым доступным, эффективным, и со знакомым рабочим процессом создания обаятельного контента.

![](images/maxtovr-levelplay.jpg)

As you get to know the interactive engine and editing tools, you'll occasionally see the name Stingray come up here and there. That's because 3ds Max Interactive is based on Autodesk's Stingray tech, the same tech that our customers are using to power a variety of [award-winning games](http://arrowheadgamestudios.com/games/helldivers/), [virtual-reality experiences](https://vimeo.com/219007622), [architectural visualizations](https://www.autodesk.com/products/revit-live/overview), and more.
Когда вы познакомитесь с интерактивным движком и инструментами редактирования, вы будете иногда видеть, как имя Stingray появляется здесь и там. Это связано с тем, что 3ds Max Interactive основан на технологии Stingray от Autodesk, той же технологии, которую наши клиенты используют для создания различных [award-winning games](http://arrowheadgamestudios.com/games/helldivers/), [virtual-reality experiences](https://vimeo.com/219007622), [architectural visualizations](https://www.autodesk.com/products/revit-live/overview), и т.п.

With 3ds Max Interactive, you'll get all the power and flexibility of Stingray, plus smoother interop with 3ds Max and Revit Live, and extra features designed specifically for 3ds Max users.

Expand Down
4 changes: 2 additions & 2 deletions source/interactive_help/animation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Animation
# Анимация

Topics in this section explain the animation tools and workflows in the interactive engine. You’ll learn how to create animations and use them in your project. These topics are intended both for animators that create animated characters and gameplay programmers that work with them in the interactive editor.
Темы этого раздела посвящены инструментам анимации и рабочему процессу анимации в interactive engine. Вы узнаете как создавать и использовать анимации в своих проектах. Эти темы предназначены как для аниматоров, создающих анимированные персонажи, так и для программистов, играющих с ними в интерактивном редакторе.

---
Related topics:
Expand Down
Loading