Added options to translate the UI (German+English included) and control the UI a bit more #97

mhoesche · 2018-02-22T13:06:48Z

Added translations to the UI - included English "en" and German "de"
Added readonly mode for the XML and Text editor
Added switches to hide UI elements when not needed
Added parameter to choose the initial display (XML or Text)

Added readonly mode for the editor Added switches to hide UI elements when not needed Added parameter to choose the initial display (XML or Text)

bbpennel

Hi, thanks for your interested in the XML editor! This PR introduces some valuable changes. I have added a number of comments and change requests

bbpennel · 2018-02-27T20:10:14Z

src/abstract_xml_object.js

+		// Set width of generated fields manually.
+		if (this.objectType.attribute && startingValue) {
+			var len = startingValue.length * 10;
+			if (len < 80) { len = 80; }


Please expand the code blocks to

if () { // code } else { }

Thanks for the review.
Yes, sure - I will update. Tried to copy the used style, but here and there I oversaw something...

bbpennel · 2018-02-27T20:51:15Z

src/jquery.xmleditor.js

+		showExport: true,
+
+		// Switch to readonly mode
+		enableEdit: true,


This is a good idea, but needs to be expanded. There are keyboard commands for editing the document that still work in readOnly mode. For instance, pressing enter/return will add a new element to the document in the "Design" mode ("XML" mode on master).

I would suggest checking for this flag in the add methods in jquery.xmleditor.js (addNode, addAttribute, addChildElement, etc)

bbpennel · 2018-02-27T21:25:37Z

src/xml_unspecified_element.js

@@ -88,7 +88,7 @@ XMLUnspecifiedElement.prototype.addContentContainers = function (recursive) {
 	var placeholder = document.createElement('div');
 	placeholder.className = 'placeholder';

-	placeholder.appendChild(document.createTextNode('Use the menu to add contents.'));
+	placeholder.appendChild(document.createTextNode(this.editor.options.i18n[this.options.userLang].useMenuToAddContents));


This line is causing an exception in /demo/mods.html, TypeError: this.options is undefined, it should be this.editor.options

Yup, wrong reference... will fix.

bbpennel · 2018-02-27T21:52:28Z

src/add_node_menu.js

@@ -42,32 +42,32 @@ AddNodeMenu.prototype.populate = function(xmlElement) {
 	}

 	if (xmlElement.allowChildren) {
-		$("<li>Add Element</li>").data('xml', {
+		$("<li>" + this.editor.options.i18n[this.editor.options.userLang].addElement  + "</li>").data('xml', {


How would you feel about shortening this into either a function like
this.editor.i18n("addElement") or a constant that gets set at startup like this.editor.i18n.addElement? Its pretty... substantial to see everywhere :)

Would be good, but I am not so much into JavaScript (actually as a Java developer, I was happy to get this far...).
Probably something to work on for the next major rework.

bbpennel · 2018-02-27T21:58:17Z

src/jquery.xmleditor.js

@@ -1196,22 +1504,31 @@ $.widget( "xml.xmlEditor", {
 	// Menu Update functions
 	refreshMenuUndo: function(self) {
 		if (self.undoHistory.headIndex > 0) {
-			$("#" + xmlMenuHeaderPrefix + "Undo").removeClass("disabled").data("menuItemData").enabled = true;
+			$("#" + xmlMenuHeaderPrefix + self.options.i18n[self.options.userLang].undoMenuitem.replaceAll(' ','_')).removeClass("disabled").data("menuItemData").enabled = true;


I am wondering if it is necessary to translate the id's of these elements? It seems like it might make styling of event binding more challenging.

Hmm, as long as menu_data.js has only the property "label", which is shown and translated, yes. But I consider changing this and have an additional "id" property for the menu-items that can be set here...

bbpennel · 2018-02-28T14:27:22Z

xsd/xsd2json.js

@@ -1,5 +1,5 @@
-;var Xsd2Json = function() {


This is the compiled file, to edit you should update xsd/src/xsd2json.js instead. Run rake xsd2json.js in order to build this file, and commit the updated version. Sorry for the confusion.

bbpennel · 2018-02-28T15:25:55Z

src/xml_element.js

@@ -223,6 +224,14 @@ XMLElement.prototype.populateChildren = function() {
 			}
 		}
 	});
+	// Patch to add "required" attributes. Does require a secondary change to know the "use" attribute also. See xsd2json-use.js : SchemaProcessor.prototype.createDefinition
+	$.each(this.objectType.attributes, function(){


this is a fairly significant change that wasn't mentioned in the commits. I'm not opposed to auto-populating required attributes, which a number of people have requested. But I can't seem to get this to work, do you have any example schema where this is adding in attributes?

Was accidentially placed here - was a special use case I didn't plan to bring in here. But I will add a example with an XSD in the demo block.
Will add a switch, to turn this off (which I set to off/false)

bbpennel · 2018-02-28T15:30:59Z

src/xml_element.js

-	deleteButton.appendChild(document.createTextNode('X'));
-	topActionSpan.appendChild(deleteButton);
-
+	if (this.editor.options.enableEdit) { // Only show menu entries in edit mode, not readonly mode


There are also keyboard shortcuts that perform these actions which will still be active. I'd suggest updating the action methods to prevent them from making changes. See GUIEditor.prototype.deleteSelected and similar methods.

bbpennel · 2018-02-28T15:31:18Z

src/xml_templates.js

@@ -3,6 +3,7 @@
 * @param init_object
 * @constructor
 */
+


remove line

bbpennel · 2018-02-28T15:42:59Z

src/abstract_xml_object.js

@@ -46,17 +47,30 @@ AbstractXMLObject.prototype.createElementInput = function (inputID, startingValu
 			|| this.objectType.attribute || this.objectType.cdata || this.objectType.comment){
 		input = document.createElement('textarea');
 		input.id = inputID;
+		input.rows = 1; // added start size of 1 row
+		input.style.height = '18px'; // Predefined height for 1 row. Will be expanded using jQuery.autosize


Would it work for you to override the height setting in the .attribute_container > textarea rule instead? Just a bit iffy on hardcoding a height in here unless necessary

mhoesche · 2018-03-01T17:54:59Z

I updated / changed most of your comments and committed them to my branch.
Some things have not changed: e.g. the ones where I did not place a comment above.

As I am not so familiar with GIT/GITHUB yet... do I need to pull the updated forked branch again?

Added textmode active first demo

…: false

Fixed some build issues, as rake doesn't work for me

bbpennel · 2018-03-29T20:52:06Z

Sorry for the long delay, I tried reviewing this again, but it is difficult to do because this branch how so many changes on it. Would you be willing to break this PR up? A good first PR would be one that just adds the internationalization and german translation feature. After that, we could look at the read only mode, disabling the various views, etc in separate PRs.

mhoesche and others added 3 commits February 22, 2018 13:41

Added UI translation for jquery.xmleditor

3e840d9

Added readonly mode for the editor Added switches to hide UI elements when not needed Added parameter to choose the initial display (XML or Text)

Updated documentation for how to use the translation

2269339

Merge branch 'master' into master

82c696a

bbpennel requested changes Feb 28, 2018

View reviewed changes

Updated to the comments of the push to UNC master review.

34243e9

mhoesche added 6 commits March 2, 2018 08:14

Fixed wrong path in requiredAttributes.html

bb6ce87

Added readonly.html demo

cc3c64f

Added textmode active first demo

Added demo for no source / XML switch in conjunction with editEnabled…

eeec116

…: false

Fixed some problems of missing translations

3f152d4

Fixed some build issues, as rake doesn't work for me

Fixed output of combined .js files

2b09404

Fixed title of demo to be in sync with what the demo shows

ed299eb

lfarrell changed the base branch from master to main March 10, 2021 14:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added options to translate the UI (German+English included) and control the UI a bit more #97

Added options to translate the UI (German+English included) and control the UI a bit more #97

mhoesche commented Feb 22, 2018

bbpennel left a comment

bbpennel Feb 27, 2018

mhoesche Mar 1, 2018

bbpennel Feb 27, 2018

bbpennel Feb 27, 2018

mhoesche Mar 1, 2018

bbpennel Feb 27, 2018

mhoesche Mar 1, 2018

bbpennel Feb 27, 2018

mhoesche Mar 1, 2018 •

edited

Loading

bbpennel Feb 28, 2018

bbpennel Feb 28, 2018

mhoesche Mar 1, 2018

bbpennel Feb 28, 2018

bbpennel Feb 28, 2018

bbpennel Feb 28, 2018

mhoesche commented Mar 1, 2018

bbpennel commented Mar 29, 2018

Added options to translate the UI (German+English included) and control the UI a bit more #97

Are you sure you want to change the base?

Added options to translate the UI (German+English included) and control the UI a bit more #97

Conversation

mhoesche commented Feb 22, 2018

bbpennel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhoesche Mar 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhoesche commented Mar 1, 2018

bbpennel commented Mar 29, 2018

mhoesche Mar 1, 2018 •

edited

Loading