You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
368 lines
11 KiB
368 lines
11 KiB
<?xml version="1.0" ?>
|
|
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
|
|
<!ENTITY kpicosim "<application>KPicoSim</application>">
|
|
<!ENTITY kappname "&kpicosim;"><!-- Do *not* replace kappname-->
|
|
<!ENTITY package "kde-module"><!-- tdebase, tdeadmin, etc -->
|
|
<!ENTITY % addindex "IGNORE">
|
|
<!ENTITY % English "INCLUDE"><!-- change language only here -->
|
|
|
|
|
|
<!-- Do not define any other entities; instead, use the entities
|
|
from kde-genent.entities and $LANG/user.entities. -->
|
|
]>
|
|
<!-- kdoctemplate v0.8 October 1 1999
|
|
Minor update to "Credits and Licenses" section on August 24, 2000
|
|
Removed "Revision history" section on 22 January 2001
|
|
Changed to Installation/Help menu entities 18 October 2001
|
|
Other minor cleanup and changes 18 October 2001 -->
|
|
|
|
|
|
<!--
|
|
This template was designed by: David Rugge davidrugge@mindspring.com
|
|
with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
|
|
and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
|
|
of the KDE DocBook team.
|
|
|
|
You may freely use this template for writing any sort of KDE documentation.
|
|
If you have any changes or improvements, please let us know.
|
|
|
|
Remember:
|
|
- in XML, the case of the <tags> and attributes is relevant ;
|
|
- also, quote all attributes.
|
|
|
|
Please don't forget to remove all these comments in your final documentation,
|
|
thanks ;-).
|
|
-->
|
|
|
|
<!-- ................................................................ -->
|
|
|
|
<!-- The language must NOT be changed here. -->
|
|
|
|
<book lang="&language;">
|
|
|
|
<!-- This header contains all of the meta-information for the document such
|
|
as Authors, publish date, the abstract, and Keywords -->
|
|
|
|
<bookinfo>
|
|
<title>The &kpicosim; Handbook</title>
|
|
|
|
<authorgroup>
|
|
<author>
|
|
<firstname></firstname>
|
|
<othername></othername>
|
|
<surname>Mark Six</surname>
|
|
<affiliation>
|
|
<address><email>m6@xs4all.nl</email></address>
|
|
</affiliation>
|
|
</author>
|
|
</authorgroup>
|
|
|
|
<!-- TRANS:ROLES_OF_TRANSLATORS -->
|
|
|
|
<copyright>
|
|
<year>1999</year>
|
|
<year>%{YEAR}</year>
|
|
<holder>Mark Six</holder>
|
|
</copyright>
|
|
<!-- Translators: put here the copyright notice of the translation -->
|
|
<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook
|
|
and in the FDL itself on how to use it. -->
|
|
<legalnotice>&FDLNotice;</legalnotice>
|
|
|
|
<!-- Date and version information of the documentation
|
|
Don't forget to include this last date and this last revision number, we
|
|
need them for translation coordination !
|
|
Please respect the format of the date (YYYY-MM-DD) and of the version
|
|
(V.MM.LL), it could be used by automation scripts.
|
|
Do NOT change these in the translation. -->
|
|
|
|
<date>2001-10-18</date>
|
|
<releaseinfo>0.1</releaseinfo>
|
|
|
|
<!-- Abstract about this handbook -->
|
|
|
|
<abstract>
|
|
<para>
|
|
&kpicosim; is an IDE for the picoBlaze microcontroller. The documentation is very minimalistic, sorry...
|
|
</para>
|
|
</abstract>
|
|
|
|
<!-- This is a set of Keywords for indexing by search engines.
|
|
Please at least include KDE, the KDE package it is in, the name
|
|
of your application, and a few relevant keywords. -->
|
|
|
|
<keywordset>
|
|
<keyword>KDE</keyword>
|
|
<keyword>KPicoSim</keyword>
|
|
<keyword>nothing</keyword>
|
|
<keyword>nothing else</keyword>
|
|
</keywordset>
|
|
|
|
</bookinfo>
|
|
|
|
<!-- The contents of the documentation begin here. Label
|
|
each chapter so with the id attribute. This is necessary for two reasons: it
|
|
allows you to easily reference the chapter from other chapters of your
|
|
document, and if there is no ID, the name of the generated HTML files will vary
|
|
from time to time making it hard to manage for maintainers and for the CVS
|
|
system. Any chapter labelled (OPTIONAL) may be left out at the author's
|
|
discretion. Other chapters should not be left out in order to maintain a
|
|
consistent documentation style across all KDE apps. -->
|
|
|
|
<chapter id="introduction">
|
|
<title>Introduction</title>
|
|
|
|
<!-- The introduction chapter contains a brief introduction for the
|
|
application that explains what it does and where to report
|
|
problems. Basically a long version of the abstract. Don't include a
|
|
revision history. (see installation appendix comment) -->
|
|
|
|
<para>
|
|
&kpicosim; is a development environment for the Xilinx PicoBlaze-3 soft-core processor for the TDE Desktop (Linux). The environment has an editor with syntax highlighting, compiler, simulator and export functions to VHDL, HEX and MEM files.
|
|
</para>
|
|
</chapter>
|
|
|
|
<chapter id="using-kpicosim">
|
|
<title>Using &kpicosim;</title>
|
|
|
|
<!-- This chapter should tell the user how to use your app. You should use as
|
|
many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
|
|
your application. -->
|
|
|
|
<para>
|
|
|
|
<!-- Note that all graphics should be in .png format. Use no gifs because of
|
|
patent issues. -->
|
|
|
|
<screenshot>
|
|
<screeninfo>Here's a screenshot of &kpicosim;</screeninfo>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<imageobject>
|
|
<imagedata fileref="screenshot.eps" format="EPS"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>Screenshot</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</para>
|
|
|
|
|
|
<sect1 id="kpicosim-features">
|
|
<title>More &kpicosim; features</title>
|
|
<para>To be written</para>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter id="commands">
|
|
<title>Command Reference</title>
|
|
|
|
<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
|
|
application windows and their menubar and toolbar commands for easy reference.
|
|
Also include any keys that have a special function but have no equivalent in the
|
|
menus or toolbars. This may not be necessary for small apps or apps with no tool
|
|
or menu bars. -->
|
|
|
|
<sect1 id="kpicosim-mainwindow">
|
|
<title>The main &kpicosim; window</title>
|
|
|
|
<sect2>
|
|
<title>The File Menu</title>
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<shortcut>
|
|
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
|
|
</shortcut>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>New</guimenuitem>
|
|
</menuchoice></term>
|
|
<listitem><para><action>Creates a new document</action></para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<shortcut>
|
|
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
|
|
</shortcut>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>Save</guimenuitem>
|
|
</menuchoice></term>
|
|
<listitem><para><action>Saves the document</action></para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<shortcut>
|
|
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
|
|
</shortcut>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>Quit</guimenuitem>
|
|
</menuchoice></term>
|
|
<listitem><para><action>Quits</action> &kpicosim;</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>The <guimenu>Help</guimenu> Menu</title>
|
|
|
|
<!-- Assuming you have a standard help menu (help, what's this, about -->
|
|
<!-- &kpicosim;, about KDE) then the documentation is already written. -->
|
|
<!-- The following entity is valid anywhere that a variablelist is -->
|
|
<!-- valid. -->
|
|
|
|
&help.menu.documentation;
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter id="developers">
|
|
<title>Developer's Guide to &kpicosim;</title>
|
|
|
|
<!-- (OPTIONAL) A Programming/Scripting reference chapter should be
|
|
used for apps that use plugins or that provide their own scripting hooks
|
|
and/or development libraries. -->
|
|
|
|
<para>
|
|
....Also this has to be written...
|
|
</para>
|
|
|
|
<!-- Use refentries to describe APIs. Refentries are fairly complicated and you
|
|
should consult the docbook reference for further details. The example below was
|
|
taken from that reference and shortened a bit for readability. -->
|
|
</chapter>
|
|
<chapter id="faq">
|
|
<title>Questions and Answers</title>
|
|
|
|
<!-- (OPTIONAL but recommended) This chapter should include all of the silly
|
|
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
|
|
should be reserved for BRIEF questions and answers! If one question uses more
|
|
than a page or so then it should probably be part of the
|
|
"Using this Application" chapter instead. You should use links to
|
|
cross-reference questions to the parts of your documentation that answer them.
|
|
This is also a great place to provide pointers to other FAQ's if your users
|
|
must do some complicated configuration on other programs in order for your
|
|
application work. -->
|
|
|
|
&reporting.bugs;
|
|
&updating.documentation;
|
|
|
|
<qandaset id="faqlist">
|
|
<qandaentry>
|
|
<question>
|
|
<para>How do I compile a file?</para>
|
|
</question>
|
|
<answer>
|
|
<para>Select in the Menu: Debug->Compile.</para>
|
|
</answer>
|
|
</qandaentry>
|
|
</qandaset>
|
|
</chapter>
|
|
|
|
<chapter id="credits">
|
|
|
|
<!-- Include credits for the programmers, documentation writers, and
|
|
contributors here. The license for your software should then be included below
|
|
the credits with a reference to the appropriate license file included in the KDE
|
|
distribution. -->
|
|
|
|
<title>Credits and License</title>
|
|
|
|
<para>
|
|
&kpicosim;
|
|
</para>
|
|
<para>
|
|
Program copyright 2005 Mark Six <email>m6@xs4all.nl</email>
|
|
</para>
|
|
<para>
|
|
Documentation copyright 2005 Mark Six <email>m6@xs4all.nl</email>
|
|
</para>
|
|
|
|
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
|
|
|
|
&underFDL; <!-- FDL: do not remove -->
|
|
<!-- Determine which license your application is licensed under,
|
|
and delete all the remaining licenses below:
|
|
|
|
(NOTE: All documentation are licensed under the FDL,
|
|
regardless of what license the application uses) -->
|
|
&underGPL; <!-- GPL License -->
|
|
|
|
</chapter>
|
|
|
|
<appendix id="installation">
|
|
<title>Installation</title>
|
|
|
|
<sect1 id="getting-kpicosim">
|
|
<title>How to obtain &kpicosim;</title>
|
|
|
|
<!-- This first entity contains boiler plate for applications that are
|
|
part of KDE CVS. You should remove it if you are releasing your
|
|
application -->
|
|
|
|
<para>
|
|
The source code is available at <ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/kpicosim">https://mirror.git.trinitydesktop.org/gitea/TDE/kpicosim</ulink> .
|
|
</para>
|
|
|
|
</sect1>
|
|
|
|
<sect1 id="requirements">
|
|
<title>Requirements</title>
|
|
|
|
<!--
|
|
List any special requirements for your application here. This should include:
|
|
.Libraries or other software that is not included in tdesupport,
|
|
tdelibs, or tdebase.
|
|
.Hardware requirements like amount of RAM, disk space, graphics card
|
|
capabilities, screen resolution, special expansion cards, etc.
|
|
.Operating systems the app will run on. If your app is designed only for a
|
|
specific OS, (you wrote a graphical LILO configurator for example) put this
|
|
information here.
|
|
-->
|
|
|
|
<para>
|
|
&kpicosim; relies on the TDE libraries (tdelibs) to build.
|
|
</para>
|
|
|
|
<para>
|
|
..Write me...
|
|
</para>
|
|
|
|
<!-- For a list of updates, you may refer to the application web site
|
|
or the ChangeLog file, or ... -->
|
|
</sect1>
|
|
|
|
<sect1 id="compilation">
|
|
<title>Compilation and Installation</title>
|
|
|
|
<!-- This entity contains the boilerplate text for standard -->
|
|
<!-- compilation instructions. If your application requires any -->
|
|
<!-- special handling, remove it, and replace with your own text. -->
|
|
|
|
<para>
|
|
In order to compile and install &kpicosim; on your system, you will need cmake.
|
|
|
|
<screen width="40">
|
|
<prompt>%</prompt> <userinput>mkdir -p build</userinput>
|
|
<prompt>%</prompt> <userinput>cd build</userinput>
|
|
<prompt>%</prompt> <userinput>cmake ..</userinput>
|
|
<prompt>%</prompt> <userinput>make install</userinput>
|
|
</screen>
|
|
|
|
For further instructions, please, read the INSTALL file.
|
|
</para>
|
|
|
|
</sect1>
|
|
|
|
</appendix>
|
|
|
|
&documentation.index;
|
|
</book>
|