21:null 22:["$","title",null,{"children":"Text highlighting for the Easy Approach to Requirements Syntax (EARS) | johnwelford | Observable"}] 27:Tf57,working = html`

The engine control system shall modulate fuel flow.
While in icing conditions the engine control system shall activate anti-icing.
When ignition is commanded the engine control system shall provide ignition.
While on ground when reverse thrust is commanded the engine control system shall enable reverse thrust.
If aircraft air data is erroneous then the engine control system shall use engine air data.
This is not a situation where a requirement statement is needed.
The car shall have a maximum retail sale price of XXX.
The car shall be compliant with the safety requirements defined in XXX.
The laptop shall have a mass of no more than XXX grams.
The laptop shall have a minimum battery life of XXX hours.
When clutch pedal is depressed the car shall disengage the driving force.
While off when power button is pressed the laptop shall boot up.
While running when closed the laptop shall enter "powersave" mode.
While ignition is on the car shall display the fuel level and the oil level to the driver.
While key is in the ignition the car alarm shall be inhibited.
While handbrake is applied the car wheels shall be locked.
While running on the battery and the battery is below XXX % charge the laptop shall display "low battery".
Where has electric windows the electric window controls shall be on the driver's door panel.
Where includes automatic windscreen wipers the car shall sense moisture on the windscreen and operate the windscreen wipers without driver commands.
Where "long life" battery is fitted the laptop shall have a minimum battery life of XXX hours.
Where a "lightweight" model the laptop shall have a mass of no more than XXX grams.
If detects attempted intrusion then the car shall operate the car alarm.
If low oil pressure then the car shall display a "low oil pressure" warning.
If incorrect password is entered then the laptop shall display XXX warning message.
Where being being driven forwards above a speed of XXX if driver attempts to engage reverse gear then the car shall prevent engagement of reverse gear.
Where includes "voice input" option while the voice input option is selected the laptop shall accept voice input commands.
While running on mains electrical power if power cable is disconnected then the laptop shall display a warning message.
The system shall have a matte finish.
When button is pressed the system ringer shall silence.
If A/C power is lost then the backup battery shall power the system with no interruption in service.
While system is in S1 state the volume button shall remain functional.
Where dual-band radios are available 3G shall receive priority.
While video is playing on-screen if A/C power is lost the screen shall dim.
When DVD is inserted into the DVD player the OS shall spin up the optical drive.
If measured and calculated speeds vary by more than 10% then the software shall use the measured speed.
If the memory checksum is invalid then the software shall display an error message.
If the ATM card inserted is reported lost or stolen then the software shall confiscate the card.
While in Low Power Mode the software shall keep the display brightness at the Minimum Level.
While the heater is on the software shall close the water intake valve.
Where a thesaurus is part of the software package the installer shall prompt the user before installing the thesaurus.
Where hardware encryption is installed the software shall encrypt data using the hardware instead of using a software algorithm.
When detects the J7 jumper is shorted the software shall clear all stored user names and passwords.
If detects an invalid DRAM memory configuration then the software shall abort the test and report the error.
While in Manufacturing Mode the software shall boot without user intervention.
Where both 3G and Wi-Fi radios are available the software shall prioritize Wi-Fi connections above 3G.

`28:T59a,extended = html`

While on DC power if the software detects an error then the software shall cache the error message instead of writing the error message to disk.
When the "turn indicator" command is received the car shall operate the indicator lights on the front, side and rear of the vehicle, and provide audible and visual confirmation to the driver.
While external audio output device is connected the laptop shall mute the built-in speaker and send the audio output signal to the external audio output device.
Where includes an "owner alert" system if detects attempted intrusion then the car shall send a message to the owner.
While the autopilot is engaged the software shall display a visual indication to the pilot.
When water level falls below the Low Water Threshold the software shall open the water valve to fill the tank to the High Water Threshold.
When Unregistered Device is plugged into a USB port the OS shall attempt to locate and load the driver for the device.
Where a HDMI port is present the software shall allow the user to select HD content for viewing.
Where a second optical drive is installed when the user selects to copy disks the software shall display an option to copy directly from one optical drive to the other optical drive.
While in start up mode when detects an external flash card the software shall use the external flash card to store photos.

`29:Tfbf,PrismEars = ({ 'requirement': { pattern: /[^.\n]* (shall|should|may) [^.]*\./i, // ignore statements without the defined auxiliary verbs inside: { 'option': { pattern: /(\bwhere\b)(.*?)(?=(\bshall\b|\bshould\b|\bmay\b|\bthen\b|\bif\b|\bwhen\b|\bwhile\b))/i, lookbehind: true, inside: { // for the case where systems cannot be separated from options 'option': /(\bthe\b).*(?=\bthe\b)/i, // multiple 'the's are still an option 'system': { pattern: /(\bthe\b)(.*)/i, lookbehind: true, }, 'joining': /\b(the)\b/i, } }, 'option-keyword': /\bwhere\b/i, 'condition': { pattern: /(\bwhile\b)(.*?)(?=(\bshall\b|\bshould\b|\bmay\b|\bthen\b|\bif\b|\bwhen\b))/i, lookbehind: true, inside: { // for the case where systems cannot be separated from conditions 'condition': /(\bthe\b).*(?=\bthe\b)/i, // multiple 'the's are still a condition 'system': { pattern: /(\bthe\b)(.*)/i, lookbehind: true, }, 'joining': /\bthe\b/i, } }, 'condition-keyword': /\b(while)\b/i, 'trigger': { // single trigger pattern: /(\b(when|if)\b)(.*?)(?=(\bshall\b|\bshould\b|\bmay\b))/i, lookbehind: true, inside: { // for the case where systems cannot be separated from triggers 'trigger': /(\bthe\b).*(?=\bthe\b)/i, // multiple 'the's are still a trigger // 'trigger': { // pattern: /(\bif\b)(.*?)(?=(\bshall\b|\bshould\b|\bmay\b))/i, // lookbehind: true, // inside: { // for the case where systems cannot be separated from triggers // 'trigger': /(\bthe\b).*(?=\bthe\b)/i, // multiple 'the's are still a trigger // 'system': { // pattern: /(\bthe\b)(.*)/i, // lookbehind: true, // }, // 'trigger-keyword': /\bthen\b/i, // 'joining': /\bthe\b/i, // } // }, 'system': { pattern: /(\bthe\b)(.*)/i, lookbehind: true, }, 'trigger-keyword': /\bthen\b/i, 'joining': /\bthe\b/i, } }, 'trigger-keyword': /\b(when|if)\b/i, // 'trigger': { // multiple trigger // pattern: /(\b(when)\b)(.*?)(?=(\bif\b))/i, // lookbehind: true, // inside: { // for the case where systems cannot be separated from triggers // 'trigger': /(\bthe\b).*(?=\bthe\b)/i, // multiple 'the's are still a trigger // // 'trigger': { // // pattern: /(\bif\b)(.*?)(?=(\bshall\b|\bshould\b|\bmay\b))/i, // // lookbehind: true, // // inside: { // for the case where systems cannot be separated from triggers // // 'trigger': /(\bthe\b).*(?=\bthe\b)/i, // multiple 'the's are still a trigger // // 'system': { // // pattern: /(\bthe\b)(.*)/i, // // lookbehind: true, // // }, // // 'trigger-keyword': /\bthen\b/i, // // 'joining': /\bthe\b/i, // // } // // }, // // 'system': { // // pattern: /(\bthe\b)(.*)/i, // // lookbehind: true, // // }, // 'trigger-keyword': /\bthen\b/i, // 'joining': /\bthe\b/i, // } // }, // 'trigger-keyword': /\bif\b/i, 'system': { pattern: /(\bthe\b)(.*)(?=(\bshall|\bshould|\bmay))/i, lookbehind: true, }, 'response': { pattern: /(\bshall|\bshould|\bmay)\b(.*)(?=.)/i, lookbehind: true, inside: { 'system': { pattern: /\b(to|from)\b(.*)/i, lookbehind: true, }, 'joining': /\bthe\b/i, 'interface-keyword': /\b(to|from)\b/i } }, 'auxiliary-verb': /\b(shall|should|may)\b/i, 'joining': /\bthe\b/i, } } })2a:[] 25:{"id":"bbf7b91124642156","slug":"text-highlighting-for-the-easy-approach-to-requirements-sy","title":"Text highlighting for the Easy Approach to Requirements Syntax (EARS)","thumbnail":"285ce94d30a721e559004f29269df32394726d1898307bf1d300b3292831d9c7","access_level":"public","create_time":"$D2022-01-27T11:40:51.445Z","update_time":"$D2022-03-29T11:31:44.186Z","view_time":null,"first_public_time":"$D2022-01-28T02:03:44.185Z","has_unpublished_edits":null,"fork":{"id":"fc8458f3d90fd244","slug":"defining-a-new-language-for-syntax-highlighting-in-prism-js","title":"Defining a new language for syntax highlighting in Prism.js","owner":{"id":"6c1f25ef90c27e9b","login":"johnwelford","name":""}},"stars":1,"starred":false,"owner":{"type":"team","id":"6c1f25ef90c27e9b","login":"johnwelford","name":"","avatar_url":"https://avatars-next.observableusercontent.com/3bfe9ac5315b1340bf914c84d1ed0ae174327f3802f4ba068fcaa4c223cfb471","tier":"starter_2024","bio":""},"version":368,"publish_version":null,"role":null,"authored":false,"authors":[{"type":"individual","id":"629158c5ced3958f","login":"johnwelford","name":"","avatar_url":"https://avatars-next.observableusercontent.com/3bfe9ac5315b1340bf914c84d1ed0ae174327f3802f4ba068fcaa4c223cfb471","tier":null,"bio":""}],"members":[{"type":"individual","id":"629158c5ced3958f","login":"johnwelford","name":"","avatar_url":"https://avatars-next.observableusercontent.com/3bfe9ac5315b1340bf914c84d1ed0ae174327f3802f4ba068fcaa4c223cfb471","tier":null,"role":"editor"}],"comments":[],"custom_thumbnail":false,"trashed":false,"lapsed":null,"subscribed":null,"forks":3,"collection":null,"type":"notebook","body":{"titling":"auto","title":"Text highlighting for the Easy Approach to Requirements Syntax (EARS)","cells":[{"id":0,"value":"# Text highlighting for the Easy Approach to Requirements Syntax (EARS)\n\nA language extension for [Prism.js](http://jasonrivers.github.io/prism/index.html) to automatically highlight text according to the [EARS](https://alistairmavin.com/ears/) requirements syntax.\n\nHighlighting for standard EARS requirements is defined as having the general form:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"","database":"$undefined"},{"id":197,"value":"

\n  Where \t<option> \n  while \t<pre-condition(s)> \n  when/if \t<trigger> then \n  the \t<system> \n  shall\n  <system response>.\n

\nWhen the landing gear button is depressed once if the software detects that the landing gear does not lock into position then the software shall sound an alarm.\n

`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":223,"value":"I prefer to extend the syntax to cover interface requirements between systems as:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"","database":"$undefined"},{"id":226,"value":"

\n  Where \t<option> \n  while \t<pre-condition(s)> \n  when/if \t<trigger> then \n  the \t<system> \n  shall\n  <system response>\n  to/from \n  the \t<system2>.\n

","pinned":false,"hidden":false,"mode":"html","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"","database":"$undefined"},{"id":283,"value":"The highlighting somewhat works for this, but doesn't currently detect the second system:","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"","database":"$undefined"},{"id":287,"value":"$28","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":277,"value":"## Setup","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"","database":"$undefined"},{"id":10,"value":"$29","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":11,"value":"Prism = await require(`https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/prism.js`).catch(() => window.Prism);","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":349,"value":"Prism.languages.ears = PrismEars","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":365,"value":"codeStyle = html`\n`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":22,"value":"earsStyle = html`\n`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":33,"value":"Prism.highlightElement(working.querySelector(\".language-ears\"));","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":272,"value":"Prism.highlightElement(notWorking.querySelector(\".language-ears\"));","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"},{"id":304,"value":"Prism.highlightElement(extended.querySelector(\".language-ears\"));","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","providerMetadata":"$undefined","attachments":"$undefined","output":"$undefined","database":"$undefined"}],"files":"$W2a","stdlib":"1"}} 26:"$25:body"