Main

 Misc.

  Fic2HTML


Valid XHTML 1.1!

Designed With Microsoft Notepad.Exe


Fanfic To HTML

Version: 0.5



Copyright (c) 2003-4 Aaron Nowack


Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.



The author of this program can be contacted by e-mail at:


anowack@tulane.edu


The current version of the program can be found at:


http://www.mimiru.net/misc/fic2html.html


This archive should contain these files:


- fic2html.cxx (the source code)

- fic2html.exe (the program)

- readme.txt (this file)




WARNING: This is beta, maybe even alpha software (look at the version number!). It has not been tested to any great extent, and it's entirely possible that if you do something unexpected, Bad Things (tm) could happen. Let the user beware.




INSTALLATION


Installation should be fairly simple: extract fic2html.exe to a directory of your choice. If you want to be able to use the program from any directory, rather than just the one that it's installed to, extract it to a directory in your path instead. To see what directories are in your path, type "path" without the quotes at the command line.

Alternatively, one could extract to any directory and then add that directory to your path. The exact method of doing this varies depending on what version of Windows you are using, consult your Windows help files for details on changing environment variables.




USAGE


Fanfic To HTML is a command line program, meaning it can only be run from a "DOS box". If the program's directory is not in your path, you must first copy the text files you wish to use it on to it's directory.

In the command line, go to the directory containing the files (or, if you copied them to it, the program's directory). Once there, type:


fic2html input.txt output.html


replacing "input.txt" and "output.html" with the input filename and the desired output filename respectively, then hit enter. If no errors are encountered, the program WILL NOT print anything.


WARNING: Using the same file for input and output is NOT SUPPORTED and has NOT been tested. It is quite likely to fail spectacularly, possibly causing data loss.




FAQs


Q: Who's responsible for this mess?


A: One Aaron Nowack, computer science student and mediocre fanfiction author.



Q: What's it do?


A: Takes prose text input and turns it into simple HTML. It'll do it to non-prose text input too, but it won't look really good.



Q: What sort of HTML does Fanfic To HTML output?


A: Fanfic To HTML should only output valid XHTML 1.1. The validity of the output file can be checked by visiting:


http://validator.w3.org/


If the output does not validate, it's a bug. Please send me the input and output files, and I'll try and fix the problem in the next version.



Q: Does Fanfic To HTML have any special formatting rules I should be aware of?


A: Yes. Any group of multiple asterisks outside of a paragraph will be changed to a horizontal rule. Asterisks inside a paragraph should not be affected. If they are, it's a bug. Please send me the input and output files, and I'll try and fix the problem in the next version.



Q: The output looks really bad in my web-browser! What can I do to make it look better?


A: CSS style sheets are the answer. A good guide to using them to format prose can be found at:


http://www.josephpalmer.com/fanfic/format/Format2_0.shtml


To aid in using style sheets, in the output file all text is enclosed in a <div class="story">.



Q: I want to use this on another OS! What should I do?


A: This program is written in C++, and compiled on MinGW. The source code is simple enough that I suspect it will compile with only trivial changes, if that, on any platform with a C++ compiler.


If you have compiled a working version for another OS, feel free to modify this readme file appropriately, re-archive everything, and send me the results. I'll then post your version along with the current one.



Q: Yeesh, that code is bad. Why didn't you make it closed source and spare yourself the embarrassment?


A: I'm a glutton for punishment, what can I say?



Q: Hey... nobody's asked any questions! You're just making these up!


A: Err... actually, you're right. That's enough then.




Change Log


v0.5

- Added code to make sure the user wants to overwrite an already existing file.

- Fanfic To HTML will now turn characters that exist in Microsoft's Latin-1 character set (CP1252) but not ISO-8859-1 (such as 'curly' apostrophes and quote marks) into the appropriate HTML character escapes.

v0.4

- First public release.