java4python icon indicating copy to clipboard operation
java4python copied to clipboard

Indexing needs improvement throughout

Open pearcej opened this issue 5 months ago • 2 comments

Indices should:

  1. Serve as a reference for all important concepts and code terminology.
  2. All code such as while should be placed in the index as <idx><c>while</c></idx>. Of course, you cannot see anything that is between <idx> tags, so indexing is best done at the beginning of a sentence or paragraph.
  3. ONLY be capitalized if a proper noun or an acronym or code that must be capitalized. e.g. object-oriented programming should NOT be capitalized in the index
  4. Acronyms should appear in the index separately from what they stand for. e.g., OOP and object-oriented programming should be indexed separately.

pearcej avatar Aug 08 '25 15:08 pearcej

Working on this

FlashEb avatar Aug 08 '25 15:08 FlashEb

Yes, it looks much better! I am going to leave this open because of Point 1 above. I am not convinced that all important terminology has been indexed.

Please note that Boolean vs boolean has been corrected throughout. George Boole was a person, so 'Boolean' as an adjective should be capitalized, but not when it refers to the boolean primitive data type in Java, which is lowercase.

pearcej avatar Aug 08 '25 22:08 pearcej