Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0002006Core InformExtensionspublic2017-03-18 01:152017-04-13 11:10
Reporterdfremont 
Assigned To 
PrioritynormalSeveritymildReproducibilityalways
StatusnewResolutionopen 
Platformx86OSMac OS XOS Version10.11
Product Version6M62 
Target VersionFixed in Version 
Summary0002006: Documentation inside example in extension project causes miscompilation
DescriptionIn an example inside an extension project, having any non-indented text (which is displayed as explanatory text in the extension's documentation) causes Inform to not include any subsequent code in the "story.ni" file generated when you hit "Go!" or "Test".

I'm not finding where the fact that you're allowed to do this is discussed, but it's certainly helpful and is used by the WI Examples and some of the built-in extensions.
Minimal Source Text To Reproduce
Test Extension by Blah begins here.
Test Extension ends here.

---- DOCUMENTATION ----

Example: * Foo - zog.

	*: "Foo"

	Blor is a room.

Blah blah blah.

	*: When play begins, say "Hooray!"
Additional InformationThe generated "story.ni":

"Foo"

Blor is a room.

TagsNo tags attached.
Effect(serious/mild) Game compiles but misbehaves
Attached Files

- Relationships

-  Notes
(0004668)
mattweiner (reporter)
2017-03-21 08:21

I don't think this is allowed--I recall one of the devs saying somewhere that the markup for WI Examples is more complicated than the markup you can do for extensions.
(0004677)
dfremont (reporter)
2017-04-13 10:10

Perhaps, but as I mentioned this feature is already being used, e.g. in the built-in extension Locksmith by Emily Short. If this is not allowed it should be removed from the built-in extensions, and if it is allowed it should be described in WI 27.12.

In fact now that I look at WI 27.12 it doesn't even mention that you need a "*:" to get the code paste button to appear. Even if only one code section is allowed, that syntax needs to be explained (is it somewhere else and I just can't find it?).
(0004678)
mattweiner (reporter)
2017-04-13 11:10

For what it's worth, I found the comment I was referring to:

https://inform7.uservoice.com/forums/57320-general/suggestions/849631--extensions-revise-extension-example-presentation [^]

Emily says the examples in the main documentation have a different markup, in part because, unlike extension examples, they can be preprocessed. Perhaps built-in extension examples can also be preprocessed? I dunno.

The paste button for examples came from this suggestion of approximately the same vintage:
https://inform7.uservoice.com/forums/57320-general/suggestions/751728--extensions-examples-paste-button-for-extension-e [^]
and maybe never got documented. I agree that that's a documentation bug, and that it also might be nice to have the distinction between author-written extensions and built-in extensions explained. Especially because sometimes we learn to format examples from the extension code (that's where I found out about "*:".)

(Also I should make it clear that I'm not speaking with any official authority here, I'm just going by what I saw on uservoice.)

...actually, which examples in the built-in extensions are you seeing that are formatted like the WI examples in this way? I just went through several and none of them had interrupted code like this. The "Watchtower" example in Locksmith *looks* like this, but it's actually two separate paste buttons (the code after the non-indented bit is optional, in case you don't want Leif to be able to unlock the door automatically).

- Issue History
Date Modified Username Field Change
2017-03-18 01:15 dfremont New Issue
2017-03-21 08:21 mattweiner Note Added: 0004668
2017-04-13 10:10 dfremont Note Added: 0004677
2017-04-13 11:10 mattweiner Note Added: 0004678


Copyright © 2000 - 2010 MantisBT Group
Powered by Mantis Bugtracker