Metamation Developer Notes

  • Developer Notes
  • Resource Map
  • Tools
    • Code Formatting
    • Configuring Git
    • Assignments
    • Testing with Windows Sandbox
    • Single Binary Applications
    • Self-Updating Applications
  • Flux Workflow
    • Flux Workflow
    • Flux Development Style Guide
    • Release notes for Flux
    • SonarCloud analysis for Flux
    • Build a Flux SDK Program
    • Shipping Flux
    • Flux.Test
      • BasicBendAuto Test
      • LaserAuto.cs Detailed Documentation
      • Laserexample:Test1
  • Technical Notes
    • File formats
      • .FX File Format
      • Au(Gold) streams
      • .GEO File Format
      • .LST File Format
      • .LST file - technology
      • .BNC File Format
      • .WAD Files: Flux Resource Packages
      • .Curl Files: ASCII config information
    • Folders App
      • Data\Bendtools
      • Data\Machines
    • FluxCode
      • Welcome & Repo Map
      • Architecture & System Context
      • Subsystem *Bend* (Press Brake)
      • Subsystem *BCell* (Bend Cell Automation)
      • API Maps
      • Data Model Catalog
      • Design Patterns -- A Reader's Guide
      • Tests and Golden Paths
      • Guided Code Tours
      • CAM Glossary with Code Mapping
      • Assignments
      • Flux Onboarding Handbook
    • Data flow
      • Part
        • Part.Dwg
        • Part.Load
        • Part.Load to Part.Dwg
      • BendTech.cs
      • Bend Technology
      • Laser Cutting Technology
    • LTS (Long term support mechanism)
    • Machine ID Scheme
  • FluxTester
    • Commands and Scripts
    • Command Cookbook
    • Script Commands
    • BendTooling.cs Test Inventory
    • LaserTooling.cs Test Steps
    • Fluxtester Recipe Book
    • Nesting.cs Overview
    • Nesting.cs Recipe Book
    • Job.cs Overview
    • Job.cs Recipe Book
  • Software license
  • 3d party software
    • Python
  • Documentation
    • Bento documentation
      • Structure of a Bento page
      • Attributes
    • Software
      • Software Requirement
      • Installation
      • Git workflow for documentation contributors
    • Quick start guide
    • Workflow
      • Roles and responsibilities
      • Analyze
      • Edit
      • Proofread
      • Pre-Publish
      • Publish
      • Release cycle
      • Information required for Documentation Team
      • Checklist for Documenters
    • Styleguide
    • Flavoring
    • Translation
      • Ordering translation for a new document
    • Citations
    • Annotation
Documentation
/
Software
/
Installation

Installation

  1. Install MS Visual Studio Code

  2. Add AsciiDoc Extension

  3. Install Ruby Gems for AsciiDoctor

  4. Download Bento (May require access permission, contact documentation team)

MS Visual Studio Code

  • Contact IT administrator to install the latest version of MS Visual Studio Code.

AsciiDoc Extension from VS Code

  1. Open VS Code application and click the Extensions icon.

    VSAscii

  2. On the search field, type asciidoc and click Install under the AsciiDoc extension.

Install Ruby Gem

  1. Download the WITHOUT DEVKIT Ruby 4.0.4-1 (x64) installer from the Ruby downloads page.

    Ruby package
  2. Go to downloads, unblock the setup file and run the installer.

  3. Select Only for me when prompted.

  4. At the end of the installation remove the check for Run ridk install

    Finish installation
  5. click Finish.

Install AsciiDoctor

For TRUMPF standard PC Users:
  • Open command prompt and run the following commands:

    1. cmdkey /add:srv34prox.corp.trumpf.com /user:%username%

      You will be prompted to enter your password. After successful authentication, execute the commands shown below.
    2. gem install asciidoctor --http-proxy http://%username%@srv34prox.corp.trumpf.com:80

    3. gem install asciidoctor-html5s --http-proxy http://%username%@srv34prox.corp.trumpf.com:80

    4. gem install asciidoctor-diagram --http-proxy http://%username%@srv34prox.corp.trumpf.com:80

    5. gem install asciidoctor-pdf --http-proxy http://%username%@srv34prox.corp.trumpf.com:80

For Non TRUMPF PC Users:
  • Open command prompt and run the following commands:

    1. gem install asciidoctor to install asciidoctor.

    2. asciidoctor --version to confirm the asciidoctor installation.

    3. gem install asciidoctor-html5s to create html files.

    4. gem install asciidoctor-diagram to create diagrams.

    5. gem install asciidoctor-pdf to create pdf files.

Set Environment Variables for Ruby and Bento

By default, Ruby path is added to the system environment variables. If not, follow the steps below to add Ruby to the path.

Ruby path

Add C:\Ruby33-x64\bin to path in user variable.

Your latest Ruby version may be different, check the installation folder for the correct path.
Bento path

Add C:\Work to path in user variable.

SysProp

Install and Run Bento

  1. Place Bento.exe file in C:\Work.

  2. Run bento help in the command prompt to verify the installation and view available commands.

    C:\Work>bento help
    Bento 58.
    
    Compilation swtiches:
      <no parameters>       : compile project with default flavor
      -flavor=FLUX          : set flavor to FLUX
      -attribute=ATTR       : defines the conditional attribute ATTR
      -attribute=KEY:VALUE  : defines the attribute KEY to VALUE
      -rebuild              : force a complete rebuild (not incremental)
      -uixlate              : looks up UI terms from the language string tables
      -debuguixlate         : highlight every UI term in yellow
      -language=FR          : sets uixlate language (default = EN)
      -altlanguage=EN       : also includes second language translations in [Brackets]
      -checkorphans         : check for orphaned pages & images
    
    Operations:
      remove Page1          : removes the Page1.adoc page
      rename Page2 AltPage  : renames Page2.adoc to AltPage.adoc
      move Page3 Folder     : moves Page3.adoc to specified Folder
      pngcrush Folder       : optimizes PNG files in Folder (and subfolders)
      pngcrush File.png     : optimizes specific PNG file
  3. Go to any of the document folder and type bento to compile.

    Bento compilation

  4. Bento compilation may list errors, if any, which need to be fixed in order to generate the output files. Once the errors are fixed, run bento command again to compile successfully.

Contents

  • MS Visual Studio Code
  • AsciiDoc Extension from VS Code
  • Install Ruby Gem
  • Install AsciiDoctor
  • Set Environment Variables for Ruby and Bento
  • Install and Run Bento
Software Requirement Git workflow for documentation contributors

      Copyright © 2025 TRUMPF Metamation. All rights reserved.

    Compiled by Bento