User:Contribution/Chanofreq Project: Difference between revisions

Contribution (talk | contribs)
Contribution (talk | contribs)
No edit summary
Line 55: Line 55:
=== Alias support ===
=== Alias support ===


To assign an alias to a keyword (e.g., <code>channel</code>, <code>note</code>, <code>frequency</code>, <code>internal</code>,<code>default</code>):
To assign an alias for a keyword (e.g., <code>channel</code>, <code>note</code>, <code>frequency</code>, <code>internal</code>,<code>default</code>):
  @alias keyword: your_custom_alias
  @alias keyword: your_custom_alias


To assign multiple aliases, use a comma-separated list:
For multiple aliases, use a comma-separated list:
  @alias keyword1: alias1, keyword2: alias2
  @alias keyword1: alias1, keyword2: alias2


To delete an alias, use:
To remove an alias:
  @unalias: keyword
  @unalias: keyword
Once an alias is assigned to a keyword, it remains in effect throughout the entire file until a new alias is assigned to the same keyword, which will replace the previous one. The original keyword can still be used alongside the alias.


Practical example of shorthands:
Practical example of shorthands:
Line 78: Line 76:
== Behavior on Loading ==
== Behavior on Loading ==
Upon loading a Chanofreq file, all notes start in an inactive state. As the file is read, each channel and internal command activates the specified note and assigns it the corresponding frequency. If a note that is already active is specified again, its frequency is updated to the new value provided. The same process applies to any default settings defined in the file. After processing the entire file, any notes that remain unspecified are assigned the default frequency if one is set. If no default frequency is provided, these notes remain inactive.
Upon loading a Chanofreq file, all notes start in an inactive state. As the file is read, each channel and internal command activates the specified note and assigns it the corresponding frequency. If a note that is already active is specified again, its frequency is updated to the new value provided. The same process applies to any default settings defined in the file. After processing the entire file, any notes that remain unspecified are assigned the default frequency if one is set. If no default frequency is provided, these notes remain inactive.
Once an alias is assigned to a keyword, it stays effective throughout the entire file until a new alias replaces it. The original keyword can still be used alongside the alias.


== Validation Rules ==
== Validation Rules ==