search

adlnet / xAPI-Spec

The xAPI Specification describes communication about learner activity and experiences between technologies.
https://adlnet.gov/projects/xapi/
899 stars 405 forks source link

Fix named anchors for sections #1115

Closed quitterie-lcs closed 7 months ago

quitterie-lcs commented 1 year ago

Purpose

Some of anchors for cross referenced are not pointing to the requested sections titles from the table of contents. For example, when I want to go to a subsection in part2 from part 1, for some of them, it fails as the anchors are not correctly referenced. Also for some of the anchors in the table of content, the link to anchors does not fit the anchor in the title subsection

Proposal

Anchors are referenced directly in the section title. All sections anchors have been uniformized with the following pattern: _Insert here section title.

thomasturrell commented 10 months ago

Why not use the markdown syntax for links?

I realise that this document already incorporates HTML Syntax in places, however I believe in most cases it should be removed.

quitterie-lcs commented 10 months ago

@thomasturrell I totally agree with you ! As the document already partly used html syntax , I followed this pattern. But I can switch my commit to get markdown (at least for links)

thomasturrell commented 10 months ago

I think fixing the link anchors would be a good change.

quitterie-lcs commented 9 months ago

@thomasturrell it is ready for a review! I let HTML anchors for definitions here. The reasons is that we can not easily transform it with markdown. The ony possibility would be to transform each definition into a subsection as follows: 

<a name="def-verb"></a>

__Verb__: Is the action being done by the Actor within the Activity within a Statement. 
A Verb represents the "did" in "I did this".

BECOMING


#### Verb 

Is the action being done by the Actor within the Activity within a Statement. 
A Verb represents the "did" in "I did this".

In this configuration, we would be able to have markdown links in the documentation. WDYT ?

thomasturrell commented 7 months ago

@andyjohnson what is the process for reviewing this pull request? A lot of good work had gone into this pull request.

andyjohnson commented 7 months ago

Thank you for all of the work on here. I have merged it. Please note that the IEEE Open Source of the xAPI Standard (https://opensource.ieee.org/xapi) is now the most current. This will be kept as an archive, but your work has made it more usable!