Introduction

Wed is a schema-aware editor for XML documents. It runs in a web browser. Wed is used as part of the Buddhist Translators Workbench project as the central component that enables a team of scholars to edit and manage lexicographical articles. We aim to make it extensible by means of a stable API, but the API is likely to change quickly until we hit 1.0.

For now wed is not meant to be used alone. Rather, it is meant to be incorporated into web applications that need to edit XML documents.

People who are actually editing documents using wed should read Wed’s Help. You should also read it if you want to know about which browsers wed supports.

People who would like to customize wed or create a mode for it should consult:

• Using Wed in an Application to learn how to use wed in their own application, or build and test it,
• Advanced Usage Notes to learn about wed’s internals, design decisions, or about more complex usage scenarios,
• the API documentation to write modes or extensions for wed.

Table of Contents

• Wed’s Help
  • Editing Controls
    • Toolbar
    • The Validation Progress Bar
    • Modification and Save Status
    • The Error Pane
    • The Navigation Pane
    • The Minibuffer
    • The Location Bar
    • The Editing Pane
  • Kinds of XML Operations
  • Searching
    • Quick Search
    • Dialog Search
  • Saving
  • Copy, Cut and Paste
    • Span Mode
    • Unit Mode
  • Undo and Redo
  • Keyboard Shortcuts
  • Browser Requirements
    • Edge
    • Firefox
    • IE11
    • OS X
    • Safari
  • Complex Name Patterns
    • Brief Explanation
    • Long Technical Explanation
• Tutorials
  • Unit Selection Mode
    • Copying Attributes
    • Cutting Attributes
    • Copy-Adding Attributes
    • Cut-Adding Attributes
    • Copying Elements
    • Cutting Elements
    • Copy-Adding Elements
    • Cut-Adding Elements
• Using Wed in an Application
  • Dependencies
  • Building
  • Testing
  • Local Demos
    • Demos Saving to a Server
    • Label Visibility
  • Using
    • Options
  • Errors
  • Round-Tripping
  • The Generic Mode
  • Contributing
• Creating a Mode
• Submodes
• Advanced Usage Notes
  • Build Information
  • Deployment Considerations
  • Schema and Structure Considerations
  • Remote Logging
  • Saving
    • Ajax Saver
    • Localforage Saver
  • Testing
    • Karma-Based Tests
    • Selenium-Based Tests
  • Internals
    • The Tag v0.10.0-x
    • JavaScript Event Handling
    • Selections
    • Carets
    • Support for GUI Controls Outside Wed
    • IM Support
    • GUI Tree and Data Tree
    • Elements of the GUI Tree
    • Classes Used by Wed
    • Possible Due to Wildcard
  • Browser Issues
    • Cut, Paste, Copy
    • contenteditable
    • Synthetic Keyboard Events
    • Vetoing Mutations
    • The XPath Problem
  • Historical Notes

Downloads

View on Github.

Download a zip or tarball.

License

Wed is released under the Mozilla Public License version 2.0. Copyright Mangalam Research Center for Buddhist Languages, Berkeley, CA.

Credits

Wed is designed and developed by Louis-Dominique Dubeau (@lddubeau), Director of Software Development for the Buddhist Translators Workbench project, Mangalam Research Center for Buddhist Languages.

This software has been made possible in part by a Level I Digital Humanities Start-up Grant and a Level II Digital Humanities Start-up Grant from the National Endowment for the Humanities (grant numbers HD-51383-11 and HD-51772-13). Any views, findings, conclusions, or recommendations expressed in this software do not necessarily represent those of the National Endowment for the Humanities.