Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add inline editing menu for definitions, foreign, and code. #128

Open
25 tasks
kathi-fletcher opened this issue Feb 2, 2014 · 1 comment
Open
25 tasks

Comments

@kathi-fletcher
Copy link
Member

Design: Implement inline semantic elements.

The designs for the editor include the ability to add semantic tags to text within a sentence, (an inline element rather than a block element ).

Goals

  1. Make it possible to mark "definition terms", "foreign words", and "programming code".
  2. For definitions, make it possible to insert the definition block into the text.
  3. Encourage switching from bold/italics/underline to more semantic description.

Mockup

editor-57.html: To see the action

  • highlight any text
  • hover over text that appears bold

Basic Design

Menu icon

Menu icon

Menu

Menu opened

Highlighting some text in the body.

Menu icon

  • Selected content appears highlighted
  • Orange menu circle comes up to the left and pointing down as long as there is room for the menu to come up.
  • Orange circle points up if the menu needs to go up to fit in the window.
  • If you hover over the orange circle it says, "Click menu for more formatting options"

Hovering over an emphasized or semantic inline element

Menu icon hovered

  • Content inside the emphasis or semantic region highlights
  • The rest is the same as above

Clicking on the menu

Inline menu clicked

  • If the item is semantic (like a definition's term), check that item in the menu.
  • If the item is just emphasized bold, italics, or underlined, don't check anything
  • Include "key term" bold, "foreign text" italicized, "code font" monospaced, and "unformatted" plain.

Clicking on the "(?)"

Clicking on help

  • Bring up side help, with the two bolded headings shown in the image above.
  • Variation for the first para "This menu appears under highlighted text, emphasized text, and special features like key terms. It provides a quick way to mark text with special features. If you just want to use bold or italics, those can be found in the toolbar at the top of the content."

Clicking on "key term"

Clicking on key term

  • if unchecked, add a check mark
  • pull up side option "Define now (optional)"
  • add <term></term> around the highlighted text

Clicking on "Define now (optional)"

Clicking on define now

  • drop in a definition block beneath the current block
  • auto supply the highlighted text as the term next to "Definition"
  • variation: should be the same as if you dragged a definition here. In other words we are not implementing the "Move this definition to the glossary" or "add meaning" yet.

Clicking on "foreign"

  • if unchecked, add a check mark
  • add <span class="foreign"></span> around the highlighted text
  • if data-type has been accepted: add <span data-type="foreign"></span> around the highlighted text

Clicking on "code font"

  • if unchecked, add a check mark
  • add <pre class="programlisting"></pre> around the highlighted text
  • if data-type has been accepted: add <pre data-type="programlisting"></pre> around the highlighted text

Clicking on "unformatted"

  • if unchecked, add a check mark
  • remove the inline formatting from this text.
@izak
Copy link

izak commented Mar 14, 2014

This might get us close to an initial version: http://lab.jakiestfu.com/contextjs/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants