Re: [asciidoc-wg] Reasons to not use Asciidoc as a foundation for a soft

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]

Re: [asciidoc-wg] Reasons to not use Asciidoc as a foundation for a software documentation language -- experiences from the N4JS project

From: Jesse McConnell <jesse.mcconnell@xxxxxxxxx>
Date: Mon, 17 Feb 2020 05:49:51 -0600
Delivered-to: asciidoc-wg@xxxxxxxxxxx
List-archive: <https://www.eclipse.org/mailman/private/asciidoc-wg>
List-help: <mailto:asciidoc-wg-request@eclipse.org?subject=help>
List-subscribe: <https://www.eclipse.org/mailman/listinfo/asciidoc-wg>, <mailto:asciidoc-wg-request@eclipse.org?subject=subscribe>
List-unsubscribe: <https://www.eclipse.org/mailman/options/asciidoc-wg>, <mailto:asciidoc-wg-request@eclipse.org?subject=unsubscribe>

Your linked example is indeed truly awful, but my question is, why? What has prompted the writer to manually define the IDs for every heading in the document?

We do this to ensure deep linking bookmarks on the web are persistent across iterations of the documentation. I suspect that is the case here.

Jesse

Follow-Ups:
- Re: [asciidoc-wg] Reasons to not use Asciidoc as a foundation for a software documentation language -- experiences from the N4JS project
  - From: Manfred Moser

References:
- [asciidoc-wg] Reasons to not use Asciidoc as a foundation for a software documentation language -- experiences from the N4JS project
  - From: Jens von Pilgrim
- Re: [asciidoc-wg] Reasons to not use Asciidoc as a foundation for a software documentation language -- experiences from the N4JS project
  - From: Lex Trotman

Prev by Date: [asciidoc-wg] Introduction
Next by Date: Re: [asciidoc-wg] Reasons to not use Asciidoc as a foundation for a software documentation language -- experiences from the N4JS project
Previous by thread: Re: [asciidoc-wg] Reasons to not use Asciidoc as a foundation for a software documentation language -- experiences from the N4JS project
Next by thread: Re: [asciidoc-wg] Reasons to not use Asciidoc as a foundation for a software documentation language -- experiences from the N4JS project
Index(es):
- Date
- Thread

Breadcrumbs