Giter Site home page Giter Site logo

Cross References about alan-docs HOT 1 CLOSED

alan-if avatar alan-if commented on August 16, 2024
Cross References

from alan-docs.

Comments (1)

tajmone avatar tajmone commented on August 16, 2024

Ok @thoni56, now all the original cross-reference links that were lost during document conversion have been restored.

As mentioned above, I've mainly adopted the cross reference format where the text shown is "Chapter X", "Sec. X.X" or "Appendix X".

But in some places it seemed more appropriate (IMO) to use the Section name in the link text, instead. This being a rather arbitrary choice, I've adopted this alternative approach when it seemed to me that mentioning the actual section title would add meaningful information to the reader — eg, when the referenced section deals with side topics, and providing the full title would allow the reader to associate the context of the reference (keywords or topic), whereas using just a section number would leave the reader clueless about where that extra info mentioned belonged to.

My reasoning is that the reader won't always click on the cross-reference link, but rather carry on with the current topic being studied. So, sometimes a numbered link is more than enough (ie, the reader will have to click to find out more), but at other times using the section title in the link could provide extra meaning to the context.

Of course, changing these links is just a simple issue, nothing irreversible about them — text-based links simply add the reference tile again, after a comma:

<<Some Section>>                 // xref with sec number
<<Some Section,_Some Section_>>  // xref with sec title

So any of this can be changed later on, I just followed my instict on this right now, and saw it as a chance to test the two approaches (which, by the way, can coexist peacefuly side by side, as was already the case in the original document which adopted execeptions too, according to context).

So, cross-references are now out of the way and I can start working on rebuilding the Index!

from alan-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.