documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Primer should recommend validating editor, rather than post-facto validation

Open bdarcus opened this issue 14 years ago • 5 comments

Current primer says "After making changes to a CSL style, it is always a good idea to check whether the style still validates," which suggests it's a good idea to edit without real-time validation.

You might insert something like this somewhere: "It is easiest to do XML editing with editing tools that support real-time completion and validation (such as emacs nxml mode)."


  • Bitbucket: https://bitbucket.org/bdarcus/csl-docs/issue/8
  • Originally Reported By: Bruce D'Arcus
  • Originally Created At: 2011-02-15 18:53:42

bdarcus avatar Mar 31 '11 17:03 bdarcus

Again, I think this is outside the scope of the primer. I don't consider emacs and nxml mode beginners material, and existing emacs users can probably figure this out by themselves.


Original Comment By: Rintze Zelle

bdarcus avatar Mar 31 '11 17:03 bdarcus

I can see that. But the primer is making recommendations implicitly about how to do this (the "After making changes ..." bit).

bdarcus avatar Mar 31 '11 17:03 bdarcus

Maybe we should recommend atom instead of emacs?

denismaier avatar Jun 10 '20 10:06 denismaier

Maybe we should recommend atom instead of emacs?

Yes; see the little package I created for atom. I'm happy to move the repo to csl if there's any interest in that.

I think @rmzelle already addressed this issue, however, since the text I quoted originally is no longer there.

But we could change this to do the above:

You can use a CSL validator to check a CSL style for any errors.

bdarcus avatar Jun 10 '20 11:06 bdarcus

@bdarcus Yeah, I think let's move this repo to CSL, and we can add a similar one for VS Code if a similar parent RNG validator is developed for that.

bwiernik avatar Nov 08 '20 21:11 bwiernik