hoyois / html5outliner Goto Github PK

View Code? Open in Web Editor NEW

69.0 69.0 14.0 252 KB

A Javascript implementation of the HTML outline algorithm

JavaScript 100.00%

html5outliner's People

Contributors

Stargazers

Watchers

Forkers

fwahlqvist buakos web5design nesta unor kublaj sydneyspyder git2358 nerone wooodhead ajhsu painty vb6hobbyst7

html5outliner's Issues

Depth Does Not Increase With Section Nesting

When I try to get the depth of heading elements, they always return a value of 1, as opposed to their section depth (body > article > h1 should be depth 2), regardless of where they are located in the document.

Feature Request: HTML Output

The similar h5o project has an outline object method called asHTML() that outputs an ordered list of section titles, optionally as hyperlinks (using the section’s id or generating one if there’s none), that can be used to output a table of contents. I’d like to see that in this one. Right now I am using both scripts for their unique features, which means I incur a performance hit making the client download two separate scripts that do essentially the same thing, and then running them both.

<main>-element not recognized

Keeping this up to date with the latest specs / drafts would be highly beneficial.

found an inconsistent result from https://gsnedders.html5.org/outliner/

I've tested following code both using your tools and tools from https://gsnedders.html5.org/outliner/ , and found that they return different results

<body>
    <section>
        <section>
            <h1>Wind</h1>
            <p>xxx
        </section>
        <p>yyy
        <section>
            <h1>Cloud</h3>
            <p>zzz
        </section>
        <h1>Rain</h1>
    </section>
</body>

result from your tools:

1.Document
    1.Section
        1.Wind
        2.Cloud
    2.Rain

result from https://gsnedders.html5.org/outliner/

1.Untitled Section
    1.Rain
        1.Wind
        2.Cloud

I don't know which one is more correct...

Add a licence.

Could you add a licence file so it is clear whether HTMLOutliner.js can be used in other projects and under what conditions?

I couldn’t find any in the README or the main JavaScript file. Without a specified licence “nobody else may reproduce, distribute, or create derivative works from your work”.

First heading after subsection

If I’m not mistaken, I might have found a bug.

Take this document:

<body>
    <section>
      <nav></nav>
      <h1>Only heading</h1>
    </section>
</body>

The HTML5 Outliner produces this outline:

But I think this should be the correct outline:

The current HTML5 CR says:

The first element of heading content in an element of sectioning content represents the heading for that section.

So shouldn’t it use the h1 as heading for the section even though this h1 comes after the nav?

I’m not sure what the correct behaviour is when this happens in the body sectioning root, e.g.:

<body>
  <nav></nav>
  <h1>Only Heading</h1>
</body>

The quoted spec explicitly mentions "in an element of sectioning content", so it doesn’t necessarily apply to sectioning root elements.

hoyois / html5outliner Goto Github PK

html5outliner's People

Contributors

Stargazers

Watchers

Forkers

html5outliner's Issues

Depth Does Not Increase With Section Nesting

Feature Request: HTML Output

<main>-element not recognized

found an inconsistent result from https://gsnedders.html5.org/outliner/

Add a licence.

First heading after subsection

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent