JMDict: support examples, #383

doc/p/jmdict.md

@@ -17,6 +17,13 @@
 | Wiki            | [JMdict](https://en.wikipedia.org/wiki/JMdict)                   |
 | Website         | [The JMDict Project](https://www.edrdg.org/jmdict/j_jmdict.html) |
 
+### Read options
+
+| Name            | Default | Type | Comment                      |
+| --------------- | ------- | ---- | ---------------------------- |
+| example_padding | `10`    | int  | Padding for examples (in px) |
+| example_color   |         | str  | Examples color               |
+
 ### Dependencies for reading
 
 PyPI Links: [lxml](https://pypi.org/project/lxml)

plugins-meta/index.json

@@ -1146,10 +1146,26 @@
 		"description": "JMDict",
 		"extensions": [],
 		"singleFile": true,
-		"optionsProp": {},
+		"optionsProp": {
+			"example_color": {
+				"class": "StrOption",
+				"type": "str",
+				"customValue": true,
+				"comment": "Examples color"
+			},
+			"example_padding": {
+				"class": "IntOption",
+				"type": "int",
+				"customValue": true,
+				"comment": "Padding for examples (in px)"
+			}
+		},
 		"canRead": true,
 		"canWrite": false,
-		"readOptions": {},
+		"readOptions": {
+			"example_padding": 10,
+			"example_color": ""
+		},
 		"readDepends": {
 			"lxml": "lxml"
 		},

pyglossary/plugins/jmdict.py

@@ -18,6 +18,12 @@
 	"The JMDict Project",
 )
 optionsProp = {
+	"example_color": StrOption(
+		comment="Examples color",
+	),
+	"example_padding": IntOption(
+		comment="Padding for examples (in px)",
+	),
 }
 
 
@@ -27,6 +33,10 @@ class Reader(object):
 		"lxml": "lxml",
 	}
 
+	_example_padding: int = 10
+	_example_color: str = ""
+	# _example_color: str = "#008FE1"
+
 	tagStyle = (
 		"color:white;"
 		"background:green;"
@@ -153,6 +163,42 @@ def br():
 					hf.write(desc)
 			hf.write(br())
 
+		examples = sense.findall("example")
+		if examples:
+			with hf.element("div", **{
+				"class": "example",
+				"style": f"padding: {self._example_padding}px 0px;",
+			}):
+				hf.write("Examples:")
+				with hf.element("ul"):
+					for i, elem in enumerate(examples):
+						if not elem.text:
+							continue
+						if i > 0:
+							hf.write(" ")
+						# one ex_srce (id?), one ex_text, and two ex_sent tags
+						textElem = elem.find("ex_text")
+						if textElem is None:
+							continue
+						if not textElem.text:
+							continue
+						text = textElem.text
+						sentList = []  # type: List[str]
+						for sentElem in elem.findall("ex_sent"):
+							if not sentElem.text:
+								continue
+							sentList.append(sentElem.text)
+						with hf.element("li"):
+							style = {}
+							if self._example_color:
+								style["color"] = self._example_color
+							with hf.element("font", **style):
+								hf.write(text)
+								for sent in sentList:
+									hf.write(br())
+									hf.write(sent)
+
+
 	def getEntryByElem(self, entry: "lxml.etree.Element") -> "BaseEntry":
 		from lxml import etree as ET
 		glos = self._glos