search

AnssiR66 / AlanStdLib

The Standard Library for ALAN Interactive Fiction Language
Other
5 stars 2 forks source link

StdLib Manual: §6.1.1. CLOTHING #85

Open tajmone opened 3 years ago

tajmone commented 3 years ago

Discussion and pending tasks on §6.1.1. CLOTHING of the StdLib Manual.

This section requires considerable changes to both text and code in order to mirror the latest updates to the library clothing system.

tajmone commented 3 years ago

Tuxedos Example

@AnssiR66, while working to fix the tuxedos example in §6.1.1. CLOTHING, I've taken liberty to the following improvements:

  1. Added a new §6.1.1.2. Clothing Tips & Tricks sub-section, to provide better separation for the text that follows §6.1.1.1. The clothing table.
  2. I've fixed the tuxedos source file to ensure it works with the current library, and taken liberty to add a few minor code and text enhancements.
  3. Now the tuxedos example is made available to the reader via the wedding.alan source file.
  4. Since the full code can be consulted in wedding.alan, I've reduced the code in the Manual example to just the snippets which are relevant to implementing the tuxedos.
  5. I've also added a transcript example, showing the results of the tuxedos implementation (using a real transcript an region-tags inclusion).
  6. I've expanded the tuxedos text to describe the general problem of having to deal with same-named clothing items, and how this can be handled in different contexts (hence the title of the new section "Clothing Tips & Tricks").

Hopefully, all of these changes are in line with your original intentions for the Manual.

Wedding Example Adventure

The wedding.alan adventure could be used to include further examples from the book, in case they don't fit in the other examples files. For example, we could move here some of the examples on how to customize the Hero and the message of self-directed verbs.

As mentioned in #84, the general idea is to provide the reader with a few example adventures containing the snippets shown in the Manual examples. To avoid too many files, we should pack into a single adventure as many examples as possibles, but without making any single adventure too big.

So @AnssiR66, if it's OK with you, I would like to be able to add a few extra objects (or even another room) to the wedding.alan source, if this simplifies the task of organizing and distributing the examples from/in the Manual. Of course, since the theme of this adventure is that of the marriage, I'll do my best to adapt any examples to the context.

Examples' Anchor IDs

I've also added the custom anchor ID example.tuxedos to the tuxedos example, so that it's possible to provide direct links to it, or cross-reference it from elsewhere in the document. From now on, I shall add anchor IDs to all examples, regardless of whether they are used in the Manual or not, because they are useful when someone wants to provide direct linking.

AnssiR66 commented 3 years ago

Yes, all of this is ok.