mirror of
https://github.com/tmedwards/tweego.git
synced 2025-07-05 14:10:27 -04:00
ecef9e14ea
* Add enough of a description of story format versions that the later mention of "major version" makes sense. * Change a "should" to the correct "must" in the JSON chunk warning. * Add a reminder to the Twee2->Twee v3 tip about the standard Twee file extensions.
52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
<!-- ***********************************************************************************************
|
|
FAQ & Tips
|
|
************************************************************************************************ -->
|
|
<h1 id="faq-and-tips">FAQ & Tips</h1>
|
|
|
|
This is a collection of tips, from how to avoid pitfalls to best practices.
|
|
|
|
Suggestions for new entries may be submitted by [creating a new issue](https://github.com/tmedwards/tweego/issues) at Tweego's [source code repository](https://github.com/tmedwards/tweego). **NOTE:** Acceptance of submissions ***is not*** guaranteed.
|
|
|
|
|
|
<!-- ***************************************************************************
|
|
Avoid processing files
|
|
**************************************************************************** -->
|
|
<span id="faq-and-tips-avoid-processing-files"></span>
|
|
## Avoid processing files
|
|
|
|
The way to avoid having Tweego process files is to not pass it the files in the first place—i.e., keep the files in question separate from the files you want Tweego to compile.
|
|
|
|
Using image files as an example, I would generally recommend a directory structure something like:
|
|
|
|
```
|
|
project_directory/
|
|
images/
|
|
src/
|
|
```
|
|
|
|
Where `src` is the directory you pass to Tweego, which only contains files you want it to compile—and possibly files that it will not process, like notes and whatnot. For example, while within the project directory the command:
|
|
|
|
```
|
|
tweego -o project.html src
|
|
```
|
|
|
|
Will only compile the files in `src`, leaving the image files in `images` alone.
|
|
|
|
|
|
<!-- ***************************************************************************
|
|
Convert Twee2 files to Twee v3
|
|
**************************************************************************** -->
|
|
<span id="faq-and-tips-convert-twee2-files-to-tweev3"></span>
|
|
## Convert Twee2 files to Twee v3
|
|
|
|
You may convert a Twee2 notation file to a Twee v3 notation file like so:
|
|
|
|
```
|
|
tweego -d -o twee_v3_file.twee twee2_file.tw2
|
|
```
|
|
|
|
Or, if the Twee2 notation file has a standard Twee file extension (`.tw`, `.twee`), like so:
|
|
|
|
```
|
|
tweego --twee2-compat -d -o twee_v3_file.twee twee2_file.twee
|
|
```
|