stricklandrbls commented on code in PR #838: URL: https://github.com/apache/daffodil-vscode/pull/838#discussion_r1323514299
########## src/svelte/src/components/layouts/Help.ts: ########## @@ -0,0 +1,48 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +type DescriptionBody = Array<string> + +type HelpInformation = { + title: string + sectionId: AvailableHelpSections + descriptionBody: DescriptionBody +} + +export const HelpDialogWidth = 300 +export const HelpDialogHeight = 350 +export const HelpDialogBorderWidth = 2 +export const HelpDialogLeftOffset = HelpDialogWidth + HelpDialogBorderWidth +export const HelpDialogTopOffset = HelpDialogHeight + HelpDialogBorderWidth + +const EditInstructionsHelp: HelpInformation = { + title: 'Edit Modes', + sectionId: 'edit-instructions', + descriptionBody: [ + '<h3>Multiple Byte Edits</h3>', + "To edit multiple bytes, highlight, by clicking and dragging over, a selection of bytes in either the physical or logical viewports. This will populate the \ + 'Edit' panel with the data to edit.", + '<h3>Single Byte Edits</h3>', + 'To edit a single byte, simply click any singular byte within either of the viewports. This is replace the content with an input field to perform edits.', + ], +} Review Comment: I figured that instructional information would be pretty concrete so when a developer needs to add a different category for help information then it can be hard coded here. I didn't see any reason to make it visible outside of this file and using the `AvailableHelpSections` type & object for external use that only allows defined `HelpInformation` objects as an index. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
