GithubHelp home page GithubHelp logo

flux's Introduction

Flux 3

Graphical CNXML editor for Legacy CNX platform.

Usage

  1. Clone/download repo
  2. Open index.html file in browser. Preferable in Google Chrome, since its contenteditable behaviour is most comprehensive in this case.
  3. Learn keyboard shortcuts from the front page of the app, to enable its full potential.

Basic editing

  • Adding elements: Flux3 allows to add elements template for some of the most common tags in CNXML. By putting caret in the content area and clicking on the one of the icons on yellow toolbar, user can put according element template into the content.
  • Wrapping content: Second option is to select text (only text nodes applies to this) and then click on the element icon. This effects the text to be wrapped with a single element, not whole template, since it is imposible to determin what user want to do with the text. This (bottom up) approach consist of creating the structure by wrapping text in desired elemtns.
  • Adding siblings: Sometimes user can find himself in a situation that it seems to be impossible to add another element to the tree in place they would want to. In that case it is worth to use following techniques:
    • Double click on the label of the elements that user want to add sibling to. This causes extending elements with --- text node at the end.
    • Alt + Element icon: adds a new element template after the node that have caret in it.
    • Ctrl + Alt + Element icon: adds a new element template at the end of the content.
    • Ctrl + โ†‘ or Ctrl + โ†“: when caret is in an element it moves the element before / after parent node.

Dealing with equations

  • Equations (represented in MathML) are rendered automaticly.
  • User can paste MathML markup directly to the content and it will be display as a MathJax element.
  • User can edit math by clicking on it with pressed Alt key, then put LaTeX formula into the input field.
  • All pasted MML equations are stored in Equations panel (Ctrl + space) from where they can be reuse. - Pressing Ctrl + q user can add empty equation in caret's position.

Upload to CNX

  1. Create account on CNX platform.
  2. Create/derive a module.
  3. Using flux3 tools create desirable document structure.
  4. Press alt + x to display CNXML preview.
  5. Copy entire content.
  6. Open full-source editing mode in CNX editor.
  7. Paste it instead of previous <content>...</content> tag.
  8. Save module.

Tips & tricks

  • When caret is in the element press Enter to create another element of the same type below the current one (only in Chrome).
  • When text is selected pressing Ctrl + i wraps text with XML <emphasis/> tag, style as italic. Similar when pressed Ctrl + b applies bold style (only in Chrome).

Build with

flux's People

Contributors

ludekarts avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.