<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >Conventions</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK REL="HOME" TITLE="Bochs Documentation Manual" HREF="book1.html"><LINK REL="PREVIOUS" TITLE="References and Other Tutorials" HREF="x62.html"><LINK REL="NEXT" TITLE="Reading and Writing" HREF="c104.html"></HEAD ><BODY CLASS="CHAPTER" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >Bochs Documentation Manual</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="x62.html" ACCESSKEY="P" ><<< Previous</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="c104.html" ACCESSKEY="N" >Next >>></A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><DIV CLASS="CHAPTER" ><H1 ><A NAME="CONVENTIONS" ></A >Conventions</H1 ><P >Put a &FIXME; near things that need to be fixed up. A &FIXME; causes the under construction symbol to appear, like this <IMG SRC="../images/undercon.png">.</P ><P >A &NEEDHELP; indicates, that you need someone's help in order to document something, you don't know for sure. This is mostly the case if you need inside information from a developer. The symbol looks like this: <IMG SRC="../images/undercon.png">.</P ><P >Don't get confused because &FIXME; looks the same as &NEEDHELP; - this is just for the moment. When you like to use one of them, think of what it should mean, instead of how it looks like: Take &FIXME; if you have great ideas of what to document, but have no time or no knowledge about it, or just noticed something wrong or outdated. &NEEDHELP; instead should be used to request help on something (see above).</P ><P >This is just a first try to clearify the difference between &NEEDHELP; and &FIXME;.</P ><P >To maintain a consistent spelling, some "problem words" are mentioned here, along with a hint on how to spell them. <DIV CLASS="TABLE" ><A NAME="AEN83" ></A ><P ><B >Table 1. list of problem words</B ></P ><TABLE BORDER="1" BGCOLOR="#E0E0E0" CELLSPACING="0" CELLPADDING="4" CLASS="CALSTABLE" ><TBODY ><TR ><TD >Bochs</TD ><TD >Bochs is written with a leading capital letter.</TD ></TR ><TR ><TD ><TT CLASS="FILENAME" >bochsrc</TT ></TD ><TD > This is what the Bochs configuration file should be refered as. It is a good compromise between what is common on Unix and what is possible on Windows (file names starting with a dot aren't easy to create). Remember to use <<A HREF="http://www.docbook.org/tdg/en/html/filename.html" TARGET="_top" >filename</A >>bochsrc</filename>. </TD ></TR ><TR ><TD >CD-ROM</TD ><TD >This abbreviation is written in all capital letters, with a hyphen in between.</TD ></TR ><TR ><TD >Unix</TD ><TD > Unix is written using a leading capital letter, followed by all lower-case letters. See the <A HREF="http://en.wikipedia.org/wiki/Unix#Branding" TARGET="_top" >Unix entry in Wikipedia</A >. </TD ></TR ></TBODY ></TABLE ></DIV ></P ><P ><IMG SRC="../images/undercon.png"> SGML docbook...lower case elements...indentation...remarks...master document/include files</P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="x62.html" ACCESSKEY="P" ><<< Previous</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="book1.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="c104.html" ACCESSKEY="N" >Next >>></A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >References and Other Tutorials</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" > </TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >Reading and Writing</TD ></TR ></TABLE ></DIV ></BODY ></HTML >