|
Start of Chapter 25: Releasing |
|
Back to §25.16. Walkthrough solutions |
|
Onward to §25.18. Improving the index map |
Inform 7 Home Page / Documentation
§25.17. Releasing the source text
Most authors will not want to publish the source text alongside the work itself, because this gives away all of its secrets. Inform provides the option mainly for the sake of the examples published on its own website, where making the source available is the whole point. But anyone is welcome to use the option, of course:
If Inform is not also generating a website, this produces a plain text file called "source.txt" in the "Release" folder, and there is nothing more to be said.
However, if a website is also being released, the source is also converted to a suite of web pages which are linked to and from the home page. (Each heading with substantive content is placed on its own web page, with the opening page containing a contents list.)
Comments in the source are rendered in grey. As a special feature, any comment which begins with an asterisk is considered a footnote and is printed below the source text, with a link. Thus comments thus:
Hercules is a demigod.[* We're using Greek spellings so he ought to be Heracles, but players are so much more familiar with Hercules.]
will be printed more like so:
Hercules is a demigod.[1]
...
Note
[1]. We're using Greek spellings so he ought to be Heracles, but players are so much more familiar with Hercules.
Footnotes are automatically numbered from 1 on each source page.
By default, the source text is linked from our generated webpage, if we are releasing with a webpage. If we wish to change this, we may write instead
This will create a text file containing the source for our story, and place this file in our release folder, but not create a link so that the player can find it.
Finally, we can:
which releases a stand-alone XML file in 'iFiction' format for the bibliographic data on the story file; this is the same data embedded in the blorb file itself, but having an external copy makes it easier to see what Inform has done, and some external programs can read iFiction data like this.