With commit f16f5c5, I went with this syntax:

/mouse/           A layer for mouse events:
  ⌥ quote : var(mouse_layer, 0) + notify(idmouse)  # Turn off mouse layer
  m       : mouse(x, -2000)
  n       : mouse(y, 2000)

/symnum/+/nav/    Sym & Nav Multi-layer:
  m   : left
  n   : down

This just uses a regex to caputre everything up to the final forward slash / and the everything after (stripping excess space). If the layer name is for a multi-condition layer, that will get parsed appropriately later. The only restriction for the description is that it can't contain a forward slash. This was done to resolve issues with descriptions for multi-conditional layers like the above.

With commit a741766, the parsing function will correctly interpret complex, multi-line YAML keys (using the ? indicator YAML syntax)

? /symnum/

  Numpad + Symbols Layer
:
  (x) j: "0"
  (x) k: ","

? /symnum/ +
  /nav/

  Sym & Nav Multi-layer
:
  m   : left
  n   : down
  e   : up
  i   : right

The parser will replace all the newline chars in the complex key with a space and parse it as if it were a single line, as above.

Your suggestion to use the pipe was much simpler, and I implemented it in this branch 071f038. I eventually realized there was no need to keep the delimiter within the surrounding forward slashes, and then that we could get rid of it altogether.

If you like having the visual for the delimiter, let me know and I can make it an option. Having it would also allow having forward slashes in the description.

Would you mind letting me know if you have a preference for description formatting? For example, if you'd prefer prefixing the layer name to the user defined description by default (with or without forward slashes), and, if no description is provided, what your preferred format might be? Currently it's /layer name/ layer The relevant lines are

karaml/karaml/karaml_config.py

Lines 125 to 131 in a741766

    
           for layer_key, layer_maps in yaml_data.items(): 
        
               name, description = parse_layer_key(layer_key) 
        
               manipulators: list = self.get_manipulators(name, layer_maps) 
        
               layer = {"description": description, 
        
                        "manipulators": manipulators} 
        
               layers_list.append(layer)

karaml/karaml/karaml_config.py

Lines 281 to 293 in a741766

    
           # Remove newlines from the layer name in case the user formatted the YAML 
        
           # key with the `? |` syntax to allow a multi-line string in the key. 
        
           layer_name = layer_name.replace("\n", " ") 
        
           layer_info = re.search(r"^(/.+/)(.*)", layer_name) 
        
           if not layer_info: 
        
               invalidLayerName(layer_name) 
        
           layer_name, description = map(str.strip, layer_info.groups()) 
        
           if not description: 
        
               description = f"{layer_name} layer" 
        
           return layer_name, description

	for layer_key, layer_maps in yaml_data.items():
	name, description = parse_layer_key(layer_key)

	manipulators: list = self.get_manipulators(name, layer_maps)
	layer = {"description": description,
	"manipulators": manipulators}
	layers_list.append(layer)

	# Remove newlines from the layer name in case the user formatted the YAML
	# key with the `? \|` syntax to allow a multi-line string in the key.
	layer_name = layer_name.replace("\n", " ")

	layer_info = re.search(r"^(/.+/)(.*)", layer_name)
	if not layer_info:
	invalidLayerName(layer_name)

	layer_name, description = map(str.strip, layer_info.groups())

	if not description:
	description = f"{layer_name} layer"
	return layer_name, description

Descriptions #4

Description

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions