stevedlawrence commented on code in PR #117: URL: https://github.com/apache/daffodil-vscode/pull/117#discussion_r889254035
########## INTELLISENSE.md: ########## @@ -0,0 +1,75 @@ +<!-- + 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. +--> + +# Apache Daffodil VS Code Extension Intellisense README + +The "Apache Daffodil VS Code Extension" extension provides auto completion for Data Format Description Language (DFDL) schemas. + +## Set the editor to dfdl mode + + + +## Features + +Auto suggest is triggered using control space or typing the beginning characters of an item. + + +Typing one or more unique characters will further limit the results. + + +Add the schema block + + +Completing a DFDL Format Block. + + +The '>' or '/' characters are used to close and XML tag. +Typing the initial characters and one or more unique characters will further limit the results. +Use the Tab to select an item from the drop down and to exit double quotes + + +Creating self define dfdl:complextypes and dfdl:simpleTypes. + + +The tab key can be used to complete an auto-complete item within an XML tag. +After auto complete is triggered, typing the initial character or characters will limit the suggestion results. +Inside an XML tag a space or carriage return will trigger a list of context sensitive attribute suggestions. + + +Using self defined types. + + +Using xs:choice and dfdl:Discriminator. + + +Using hidden references and dfdl:inputValueCalc + + +Using dfdl:OutputValueCalc + + +More examples of using user defined types + + +Using the dfdl:Length attribute with XPath values + + +Using dfdl:assert blocks + + +Miscellaneous examples + Review Comment: At a minimum, I think we should remove the references to external images in this PR. If you want to just remove it entirely we can figure out where the documentation and associated images want to live. That could be in this repo, or maybe the github wiki, website, etc. Lots of options to consider. I don't mind waiting until after this is merged to have that discussion. -- 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]
