Permalink
Browse files

[manual] Add manual sources

git-svn-id: http://texworks.googlecode.com/svn/manual@752 9a2a4a0b-1251-0410-9248-99fc04669920
  • Loading branch information...
st.loeffler@gmail.com
st.loeffler@gmail.com committed Mar 20, 2011
0 parents commit fe2336ad8153415796e5d37cfe05f965f0c1a9e4
Showing with 5,472 additions and 0 deletions.
  1. +13 −0 Makefile
  2. +30 −0 README
  3. +27 −0 src/Makefile
  4. +342 −0 src/en/COPYING.CC-by-sa-3.0
  5. +339 −0 src/en/COPYING.GPLv2
  6. +46 −0 src/en/Makefile
  7. +62 −0 src/en/README
  8. +43 −0 src/en/actionsAlphabetical.tex
  9. +60 −0 src/en/autocompletionBasic.tex
  10. +458 −0 src/en/autocompletionLatex.tex
  11. +30 −0 src/en/backmatter.tex
  12. +20 −0 src/en/beyond.tex
  13. +22 −0 src/en/compiling.tex
  14. +149 −0 src/en/customizing.tex
  15. +176 −0 src/en/editingtools.tex
  16. +179 −0 src/en/firststeps.tex
  17. +28 −0 src/en/frontmatter.tex
  18. +82 −0 src/en/html/Makefile
  19. +90 −0 src/en/html/manual.cfg
  20. +127 −0 src/en/html/manual.css
  21. +6 −0 src/en/html/tex4ht.env
  22. +9 −0 src/en/html/tidy.cfg
  23. +1 −0 src/en/html/tw-help-title.txt
  24. BIN src/en/images/LMB.pdf
  25. BIN src/en/images/Linux.pdf
  26. BIN src/en/images/Mac.pdf
  27. BIN src/en/images/MacCmdKey.pdf
  28. +75 −0 src/en/images/MacCmdKey.svg
  29. BIN src/en/images/MacOptKey.pdf
  30. +75 −0 src/en/images/MacOptKey.svg
  31. +172 −0 src/en/images/OSlogos.svg
  32. BIN src/en/images/RMB.pdf
  33. BIN src/en/images/TeXworks.png
  34. BIN src/en/images/Windows.pdf
  35. +546 −0 src/en/images/accessories-text-editor.svg
  36. BIN src/en/images/consoleOutput.pdf
  37. +166 −0 src/en/images/consoleOutput.svg
  38. BIN src/en/images/errorParsingScript.pdf
  39. +110 −0 src/en/images/errorParsingScript.svg
  40. BIN src/en/images/example.pdf
  41. BIN src/en/images/iconAbortTypesetting.png
  42. BIN src/en/images/iconTypeset.png
  43. +516 −0 src/en/images/input-mouse.svg
  44. BIN src/en/images/interface-summary.pdf
  45. +235 −0 src/en/images/interface-summary.svg
  46. BIN src/en/images/replaceDialog.png
  47. BIN src/en/images/screenshotConsoleOutput.png
  48. BIN src/en/images/screenshotErrorParsingScript.png
  49. BIN src/en/images/screenshotHardWrapDlg.png
  50. BIN src/en/images/screenshotPDFDocument.png
  51. BIN src/en/images/screenshotTeXDocument.png
  52. BIN src/en/images/title-quote.pdf
  53. BIN src/en/images/toolbar1.png
  54. BIN src/en/images/toolbar2.png
  55. +69 −0 src/en/installation.tex
  56. +72 −0 src/en/introduction.tex
  57. +125 −0 src/en/keysequence.sty
  58. +235 −0 src/en/manual.sty
  59. +43 −0 src/en/manual.tex
  60. +55 −0 src/en/menuactionsPDFDocument.tex
  61. +66 −0 src/en/menuactionsTeXDocument.tex
  62. +130 −0 src/en/othertools.tex
  63. +110 −0 src/en/regexps.tex
  64. +42 −0 src/en/scripting.tex
  65. +110 −0 src/en/scripts/updateActions.py
  66. +68 −0 src/en/scripts/updateAutocompletion.py
  67. +44 −0 src/en/scripts/updateShortcuts.py
  68. +32 −0 src/en/shortcutsPDFDocument.tex
  69. +37 −0 src/en/shortcutsTeXDocument.tex
@@ -0,0 +1,13 @@
.PHONY : all clean dist dist-clean
all :
$(MAKE) -C src
clean :
$(MAKE) -C src clean
dist :
$(MAKE) -C src dist
dist-clean :
$(MAKE) -C src dist-clean
30 README
@@ -0,0 +1,30 @@
Introduction
================================================================================
This package contains the sources to typeset "A short manual for TeXworks".
TeXworks is an open-source, cross-platform TeX editor designed to lower the
entry barrier to the TeX world. See http://www.tug.org/texworks/ for more
information.
The actual sources for the document (together with further information,
licensing details, etc.) are located in the src/<lang>/ folders to allow the
manual to be translated.
Typesetting
================================================================================
Assuming you have a GNU make compatible version of make installed, you can run
make
(or alternatively the name of your version, e.g., mingw32-make) in this
directory form the command line to build all pdf and html versions of the
manual. Please note that this requires pdflatex & friends to be in your $PATH.
For typesetting the html version, you additionally need ghostscript and the
ImageMagick convert tools in your path. In addition, tidy is recommended.
Note that not all parts of the makefiles are platform-independent and tested on
other than GNU/Linux systems and may thus fail on your system. In the case your
invocation doesn't produce a valid output, you can typeset the manual by
manually running the proper commands, of course.
@@ -0,0 +1,27 @@
LANGS = $(patsubst %/,manual-%,$(wildcard */))
DISTLANGS = $(patsubst manual-%,dist-%,$(LANGS))
CLEANLANGS = $(patsubst manual-%,clean-%,$(LANGS))
DISTCLEANLANGS = $(patsubst manual-%,dist-clean-%,$(LANGS))
.PHONY : all clean dist dist-clean $(LANGS) $(DISTLANGS) $(CLEANLANGS) $(DISTCLEANLANGS)
all : $(LANGS)
clean : $(CLEANLANGS)
dist : $(DISTLANGS)
dist-clean : $(DISTCLEANLANGS)
$(LANGS) :
@$(MAKE) -C $(patsubst manual-%,%,$@)
$(DISTLANGS) :
@$(MAKE) -C $(patsubst dist-%,%,$@) dist
$(CLEANLANGS) :
@$(MAKE) -C $(patsubst clean-%,%,$@) recursive-clean
$(DISTCLEANLANGS) :
@$(MAKE) -C $(patsubst dist-clean-%,%,$@) recursive-dist-clean

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -0,0 +1,46 @@
LANG=$(notdir $(abspath .))
SYNCTEX = -synctex=1
WINDOWS = $(if $(filter .exe,$(suffix $(SHELL))),"y")
SUPRESSOUT = > $(if $(WINDOWS),nul,/dev/null)
CP = $(if $(WINDOWS),copy,cp)
.PHONY : all pdf html clean dist-clean dist dist-pdf dist-html recursive-clean recursive-dist-clean
all : pdf html
pdf : manual.pdf
html :
@$(MAKE) -C html
manual.pdf : manual.ind *.tex *.sty images/*.pdf images/*.png
@pdflatex manual
@pdflatex manual
@pdflatex $(SYNCTEX) manual
manual.ind : *.tex *.sty
@pdflatex manual
@makeindex manual
clean :
rm -f *.aux *.log *.out *.idx *.ind *.ilg *.toc
dist-clean : clean
rm manual.pdf
recursive-clean : clean
@$(MAKE) -C html clean
recursive-dist-clean : dist-clean
@$(MAKE) -C html dist-clean
dist : dist-pdf dist-html
dist-pdf : manual.pdf
@mkdir -p ../../pdf/$(LANG)
@$(CP) manual.pdf ../../pdf/$(LANG)/TeXworks-manual.pdf
dist-html :
$(MAKE) -C html dist
@@ -0,0 +1,62 @@
Introduction
================================================================================
This package contains the sources to typeset "A short manual for TeXworks".
TeXworks is an open-source, cross-platform TeX editor designed to lower the
entry barrier to the TeX world. See http://www.tug.org/texworks/ for more
information.
Typesetting
================================================================================
To typeset this document, you need LaTeX. This is usually provided by a TeX
distribution such as:
* TeXLive (http://www.tug.org/texlive/)
* MiKTeX (http://www.miktex.org/)
* MacTeX (http://www.tug.org/mactex/)
Make sure you have the following required LaTeX packages installed:
amsmath, amssymb, array, babel, booktabs, calc, color, fancyhdr, fancyvrb,
fncychap, fontenc, footmisc, framed, graphicx, hyperref, idxlayout,
inputenc, keystroke, lmodern, longtable, makeidx, needspace, sectsty,
tocbibind, upquote, url, wrapfig,
and the ZapfChancery font.
When using TeXLive, these can be installed by running
tlmgr install amsfonts amsmath babel booktabs fancyhdr fancyvrb fncychap \
footmisc framed graphics hyperref idxlayout keystroke latex \
lm needspace sectsty tocbibind tools upquote url wrapfig \
zapfchan
from the command line.
If you intend to typeset in the HTML format, you also need tex4ht.
Disclaimer
================================================================================
Copyright (C) 2010-2011 Alain Delmotte, Stefan Löffler, and contributors.
Some rights reserved.
Unless noted otherwise, the icons in the images/ folder are taken from the
TeXworks project, the Tango project, or were made for this work.
This manual is free documentation: you can redistribute it and/or modify it
under the terms of either:
* the CC-BY-SA license as published by Creative Commons; either version 3 of
the License, or (at your option) any later version.
or
* the GNU General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later version.
or both in parallel. For details, see the files COPYING.CC-by-sa-3.0
and COPYING.GPLv2.
@@ -0,0 +1,43 @@
\begin{longtable}{QQ}
\toprule
actionAbout\_Scripts & actionPaste \\
actionAbout\_TW & actionPlace\_on\_Left \\
actionActual\_Size & actionPlace\_on\_Right \\
actionApply\_to\_Selection & actionPreferences \\
actionAutoIndent\_None & actionPrevious\_Page \\
actionAuto\_Follow\_Focus & actionQuit\_TeXworks \\
actionBalance\_Delimiters & actionRedo \\
actionClear & actionRemove\_Aux\_Files \\
actionClose & actionReplace \\
actionComment & actionReplace\_Again \\
actionCopy & actionRevert\_to\_Saved \\
actionCopy\_to\_Find & actionSave \\
actionCopy\_to\_Replace & actionSave\_All \\
actionCut & actionSave\_As \\
actionFind & actionScroll \\
actionFind\_Again & actionSelect\_All \\
actionFind\_Selection & actionSelect\_Image \\
actionFirst\_Page & actionSelect\_Text \\
actionFit\_to\_Width & actionShow\_Hide\_Console \\
actionFit\_to\_Window & actionShow\_Scripts\_Folder \\
actionFont & actionShow\_Selection \\
actionFull\_Screen & actionSide\_by\_Side \\
actionGoToHomePage & actionSmartQuotes\_None \\
actionGo\_to\_Line & actionStack \\
actionGo\_to\_Page & actionSyntaxColoring\_None \\
actionGo\_to\_Preview & actionTile \\
actionGo\_to\_Source & actionTo\_Lowercase \\
actionHard\_Wrap & actionTo\_Uppercase \\
actionIndent & actionToggle\_Case \\
actionLast\_Page & actionTypeset \\
actionLine\_Numbers & actionUncomment \\
actionMagnify & actionUndo \\
actionManage\_Scripts & actionUnindent \\
actionNew & actionUpdate\_Scripts \\
actionNew\_from\_Template & actionWrap\_Lines \\
actionNext\_Page & actionWriteToMailingList \\
actionNone & actionZoom\_In \\
actionOpen & actionZoom\_Out \\
actionOpen\_Recent & \\
\bottomrule
\end{longtable}
@@ -0,0 +1,60 @@
\begin{longtable}{>{\footnotesize}p{15mm}>{\footnotesize}p{15mm}>{\footnotesize}p{95mm}}
\toprule
xa & \textbackslash xa & \textbackslash alpha \\
xb & \textbackslash xb & \textbackslash beta \\
& \textbackslash bsk & \textbackslash bigskip \\
& & \textbackslash bigskip{\AutoCompRet} \\
xch & \textbackslash xch & \textbackslash chi \\
xd & \textbackslash xd & \textbackslash delta \\
xcd & \textbackslash xcd & \textbackslash Delta \\
xe & \textbackslash xe & \textbackslash epsilon \\
xet & \textbackslash xet & \textbackslash eta \\
xg & \textbackslash xg & \textbackslash gamma \\
xcg & \textbackslash xcg & \textbackslash Gamma \\
& & \textbackslash hskip \\
& & \textbackslash indent \\
& & \textbackslash input \\
xio & \textbackslash xio & \textbackslash iota \\
xl & \textbackslash xl & \textbackslash lambda \\
xcl & \textbackslash xcl & \textbackslash Lambda \\
& \textbackslash msk & \textbackslash medskip \\
& & \textbackslash medskip{\AutoCompRet} \\
xm & \textbackslash xm & \textbackslash mu \\
& & \textbackslash noindent \\
xn & \textbackslash xn & \textbackslash nu \\
xo & \textbackslash xo & \textbackslash omega \\
xco & \textbackslash xco & \textbackslash Omega \\
& & \textbackslash par \\
xcph & \textbackslash xcph & \textbackslash Phi \\
xph & \textbackslash xph & \textbackslash phi \\
xp & \textbackslash xp & \textbackslash pi \\
xcp & \textbackslash xcp & \textbackslash Pi \\
xcps & \textbackslash xcps & \textbackslash Psi \\
xps & \textbackslash xps & \textbackslash psi \\
xr & \textbackslash xr & \textbackslash rho \\
& & \textbackslash scriptsize \\
xs & \textbackslash xs & \textbackslash sigma \\
xcs & \textbackslash xcs & \textbackslash Sigma \\
& & \textbackslash smallskip{\AutoCompRet} \\
& \textbackslash ssk & \textbackslash smallskip{\AutoCompRet} \\
xt & \textbackslash xt & \textbackslash tau \\
tex & \textbackslash tex & \textbackslash TeX \\
& & \textbackslash TeX \\
texs & \textbackslash texs & \textbackslash TeX\textbackslash \\
& & \textbackslash TeX\textbackslash \\
xth & \textbackslash xth & \textbackslash theta \\
xcth & \textbackslash xcth & \textbackslash Theta \\
xu & \textbackslash xu & \textbackslash upsilon \\
xcu & \textbackslash xcu & \textbackslash Upsilon \\
xve & \textbackslash xve & \textbackslash varepsilon \\
xvph & \textbackslash xvph & \textbackslash varphi \\
xvp & \textbackslash xvp & \textbackslash varpi \\
xvr & \textbackslash xvr & \textbackslash varrho \\
xvs & \textbackslash xvs & \textbackslash varsigma \\
xvth & \textbackslash xvth & \textbackslash vartheta \\
& & \textbackslash vskip \\
xcx & \textbackslash xcx & \textbackslash Xi \\
xx & \textbackslash xx & \textbackslash xi \\
xz & \textbackslash xz & \textbackslash zeta \\
\bottomrule
\end{longtable}
Oops, something went wrong.

0 comments on commit fe2336a

Please sign in to comment.