KiCad documentation: Cheatsheet

@bdh Current documentation is currently setup in such a way that indexes are generated automatically from tags in the Asciidoc files, and this has been so for a long time.

Is there anything wrong with the current form of Index?
Asciidoc is “compiled” (if that’s the word) into different formats.
.pdf and .html have working indexes. I’m not sure about epub, I do not have much experience with that format.

@der.ule I have no Idea what an index to the single page cheatsheet would look like. Shortcut keys there are already neatly combined by subject. (Was this even a serious remark, or just an attempt at humor?)

There is no index in any of the KiCad documentation, unless I’m missing something. There is a basic table of contents, but no comprehensive index. I have only looked at .pdf and .html.

Ah, oops. My mistake.
As non-native english person I mixed up “Table of Contents” with “Index”.

Accordig to Asciidoc:
http://www.methods.co.nz/asciidoc/userguide.html
it has built in mechanisms for all kind of fancy stuff:

In addition to the normal section template names ( sect1 , sect2 , sect3 , sect4 ) AsciiDoc has the following templates for frontmatter, backmatter and other special sections: abstract , preface , colophon , dedication , glossary , bibliography , synopsis , appendix , index . These special section templates generate the corresponding Docbook elements; for HTML outputs they default to the sect1 section template.

But what use is an Index? Do people still kill trees to put grafitti on them? :slight_smile:
In any electronic format you can use a simple text search for keywords.

-WM_strip_2009-10-27

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.