We need to improve the RemoteCode component a bit to make it work in a variety of circumstances. Here's the things that I've found that are bugs or needed features.
Remote code needs to be de-indented using a least prefix approach (the line with the least whitespace prefix is used as the basis to strip whitespace from all other lines) (added in 2.3.0)
- Ability to abbreviate code using something like
// remove::foo and // end-remove::foo. Some code has very long blocks that don't need to be covered in an article. Without this, we could confuse readers and docs could become very long. We could add another attribute to the component for the replacement like removalReplacement="// ..."
- Removal of embedded tags. For example, one tag might have lines that are other tags. These should be stripped.
- Tag matching is partial not full. Therefore,
foo will make foo-bar. We should be only matching full tags
We need to improve the RemoteCode component a bit to make it work in a variety of circumstances. Here's the things that I've found that are bugs or needed features.
Remote code needs to be de-indented using a least prefix approach (the line with the least whitespace prefix is used as the basis to strip whitespace from all other lines)(added in2.3.0)// remove::fooand// end-remove::foo. Some code has very long blocks that don't need to be covered in an article. Without this, we could confuse readers and docs could become very long. We could add another attribute to the component for the replacement likeremovalReplacement="// ..."foowill makefoo-bar. We should be only matching full tags