Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

code blocks improvements #44

Open
JohnMoehrke opened this issue Nov 18, 2020 · 5 comments
Open

code blocks improvements #44

JohnMoehrke opened this issue Nov 18, 2020 · 5 comments
Labels
bug Something isn't working

Comments

@JohnMoehrke
Copy link
Contributor

JohnMoehrke commented Nov 18, 2020

switch away from XMLname as html already has a class 'code'

<code>inline text</code>

or

>  <code class=”code-block”>A whole
>  box of text
>  without having to put any other tags
>  inside</code>
> 

ALSO need consistent formatting, as within large code blocks we have inconsistent indenting.

Might want to move full examples outside the specification now that we can reference a file published on a github.

Should be able to use language specific markup (xml looking like xml, json looking like json, etc)

@JohnMoehrke JohnMoehrke added this to the Phase 2 milestone Nov 18, 2020
@JohnMoehrke JohnMoehrke added this to Phase 2: all after initial release in Publications Nov 18, 2020
@vassilpeytchev
Copy link
Contributor

vassilpeytchev commented Nov 18, 2020

One point to be aware of about code-block - it takes everything between the <code> tags literally and presents it. Code blocks should look like this:

      <p>
        Some text
      </p>
      <code class="code-block">&lt;RegistryPackage&gt;
    &lt;Classification&gt;
        &lt;...&gt;
    &lt;/Classification&gt;
&lt;/RegistryPackage&gt;</code>

Note how the content needs to be right next to the <code> tags, otherwise there will be extra blank lines in the box.

@JohnMoehrke JohnMoehrke removed this from the Phase 2: February 2021 milestone Feb 8, 2021
@JohnMoehrke JohnMoehrke moved this from Phase 2: Feb 2021 to Unknown in Publications Feb 8, 2021
@JohnMoehrke JohnMoehrke added this to the Phase 4: Summer 2021 milestone Feb 8, 2021
@vassilpeytchev
Copy link
Contributor

I think this should go to the May phase, I was close at one point to do a global replace getting 90+% done.

@JohnMoehrke JohnMoehrke moved this from no target date to May 2021 in Publications Mar 22, 2021
@JohnMoehrke JohnMoehrke added the bug Something isn't working label Jul 26, 2021
@MaryLJ
Copy link
Contributor

MaryLJ commented Jul 29, 2021

Google Sheet to track progress of fixes for this issue is at https://docs.google.com/spreadsheets/d/1eM8OgzO8qGbc9Q8lEyBtwdALFOaYZN9W-AsyV6EnXWA/edit#gid=2021735577

@qligier
Copy link
Contributor

qligier commented Mar 2, 2022

Syntax highlighting would be a welcomed feature for these code blocks.

@JohnMoehrke
Copy link
Contributor Author

Syntax highlighting would be a welcomed feature for these code blocks.

worthy new feature. This issue simply wants code blocks to be consistently marked as code blocks. That needs to come first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Publications
  
Sep 2021
Development

No branches or pull requests

4 participants