Your message dated Sat, 17 Jul 2021 12:26:48 +0200 with message-id <CAM8zJQvgq2E9Z_fNj4M1PCRcvMPQ9minOQ28f46xdehS47MOeQ@mail.gmail.com> and subject line Re: Bug#991123: unblock: texworks-manual/20210308-2 has caused the Debian Bug report #991123, regarding unblock: texworks-manual/20210308-2 to be marked as done. This means that you claim that the problem has been dealt with. If this is not the case it is now your responsibility to reopen the Bug report if necessary, and/or fix the problem forthwith. (NB: If you are a system administrator and have no idea what this message is talking about, this may indicate a serious mail system misconfiguration somewhere. Please contact owner@bugs.debian.org immediately.) -- 991123: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=991123 Debian Bug Tracking System Contact owner@bugs.debian.org with problems
--- Begin Message ---
- To: Debian Bug Tracking System <submit@bugs.debian.org>
- Cc: Debian-TeX-maint <debian-tex-maint@lists.debian.org>
- Subject: unblock: texworks-manual/20210308-2
- From: Hilmar Preusse <hille42@web.de>
- Date: Wed, 14 Jul 2021 23:08:07 +0200
- Message-id: <[🔎] YO9SN7OXrW+dFIQ6@sid.showcase.amasol.de>
- Mail-followup-to: Debian Bug Tracking System <submit@bugs.debian.org>, Debian-TeX-maint <debian-tex-maint@lists.debian.org>
Package: release.debian.org Severity: normal User: release.debian.org@packages.debian.org Usertags: unblock Please unblock package texworks-manual [ Reason ] Due to changes in ghostscript some functionalities are not provided any more. Hence some packages stopped to build correctly; this is one of them. See #987504 for background. https://tests.reproducible-builds.org/debian/rb-pkg/unstable/amd64/texworks-manual.html The Bug#986686 to solve this was filed a while ago, but was recently bumped to serious. Until recent times only Ubuntu was affected. [ Impact ] FTBFS of package remains unresolved. [ Tests ] Currently none. Test suite is under development. [ Risks ] As we don't speak about software, but documentation I don't see possible impact on other parts of the distribution. [ Checklist ] [X] all changes are documented in the d/changelog [X] I reviewed all changes and I approve them [X] attach debdiff against the package in testing [ Other info ] The debdiff is rather large, mostly it consist of changes of the documentation in that package, it does not impact the Debian packaging itself. Have a look at d/changelog for changes. unblock texworks-manual/20210308-2diff -Nru texworks-manual-20200329/debian/changelog texworks-manual-20210308/debian/changelog --- texworks-manual-20200329/debian/changelog 2021-01-31 11:07:55.000000000 +0100 +++ texworks-manual-20210308/debian/changelog 2021-07-14 21:38:28.000000000 +0200 @@ -1,7 +1,24 @@ +texworks-manual (20210308-2) unstable; urgency=medium + + * Add b-d netpbm, to solve FTBFS on Ubuntu (Closes: #986686). + * Replace b-d (-tex4ht, +texlive-plain-generic) + * Set upstream metadata fields: Bug-Database, Bug-Submit. + + -- Hilmar Preusse <hille42@web.de> Wed, 14 Jul 2021 21:38:28 +0200 + +texworks-manual (20210308-1) unstable; urgency=medium + + * New upstream version. + - doc-base integration + - fix typo in package description. + - Remove fix-build-lang patch + + -- Hilmar Preusse <hille42@web.de> Fri, 12 Mar 2021 20:24:59 +0100 + texworks-manual (20200329-1) unstable; urgency=medium * New upstream version. - - Remove fix-build-lang patch. + - Disable fix-build-lang patch. - override_dh_auto_clean, run "make dist-clean". -- Hilmar Preusse <hille42@web.de> Sun, 31 Jan 2021 11:07:55 +0100 diff -Nru texworks-manual-20200329/debian/control texworks-manual-20210308/debian/control --- texworks-manual-20200329/debian/control 2021-01-29 00:15:01.000000000 +0100 +++ texworks-manual-20210308/debian/control 2021-07-14 21:38:06.000000000 +0200 @@ -11,10 +11,11 @@ texlive-latex-extra, texlive-lang-french, texlive-luatex, - tex4ht, + texlive-plain-generic, ghostscript, lmodern, - imagemagick + imagemagick, + netpbm Standards-Version: 4.5.1 Rules-Requires-Root: no Homepage: https://www.tug.org/texworks/ @@ -28,7 +29,7 @@ Multi-Arch: foreign Description: English help files for TeXworks This is the manual for program suite TeXworks (English). - For furter information, see http://tug.org/texworks/ + For further information, see http://tug.org/texworks/ Package: texworks-help-fr Architecture: all @@ -37,4 +38,4 @@ Multi-Arch: foreign Description: French help files for TeXworks This is the manual for program suite TeXworks (French). - For furter information, see http://tug.org/texworks/ + For further information, see http://tug.org/texworks/ diff -Nru texworks-manual-20200329/debian/patches/fix-build-lang texworks-manual-20210308/debian/patches/fix-build-lang --- texworks-manual-20200329/debian/patches/fix-build-lang 2021-01-29 00:15:01.000000000 +0100 +++ texworks-manual-20210308/debian/patches/fix-build-lang 1970-01-01 01:00:00.000000000 +0100 @@ -1,49 +0,0 @@ -Description: Work around LANG induced build errors of lualatex. -Origin: Norbert Preining <norbert@preining.info> -Forwarded: Not done, could be done. Check new upstream release. -Author: Norbert Preining <norbert@preining.info> -Last-Update: 20190302 - ---- - src/en/Makefile | 6 +++--- - src/fr/Makefile | 6 +++--- - 2 files changed, 6 insertions(+), 6 deletions(-) - ---- texworks-manual.orig/src/en/Makefile -+++ texworks-manual/src/en/Makefile -@@ -1,4 +1,4 @@ --LANG=$(notdir $(abspath .)) -+CURLANG=$(notdir $(abspath .)) - - SYNCTEX = -synctex=1 - -@@ -39,8 +39,8 @@ recursive-dist-clean : dist-clean - dist : dist-pdf dist-html - - dist-pdf : manual.pdf -- @mkdir -p ../../pdf/$(LANG) -- @$(CP) manual.pdf ../../pdf/$(LANG)/TeXworks-manual-$(LANG).pdf -+ @mkdir -p ../../pdf/$(CURLANG) -+ @$(CP) manual.pdf ../../pdf/$(CURLANG)/TeXworks-manual-$(CURLANG).pdf - - dist-html : - $(MAKE) -C html dist ---- texworks-manual.orig/src/fr/Makefile -+++ texworks-manual/src/fr/Makefile -@@ -1,4 +1,4 @@ --LANG=$(notdir $(abspath .)) -+CURLANG=$(notdir $(abspath .)) - - SYNCTEX = -synctex=1 - -@@ -39,8 +39,8 @@ recursive-dist-clean : dist-clean - dist : dist-pdf dist-html - - dist-pdf : manuel.pdf -- @mkdir -p ../../pdf/$(LANG) -- @$(CP) manuel.pdf ../../pdf/$(LANG)/TeXworks-manual-$(LANG).pdf -+ @mkdir -p ../../pdf/$(CURLANG) -+ @$(CP) manuel.pdf ../../pdf/$(CURLANG)/TeXworks-manual-$(CURLANG).pdf - - dist-html : - $(MAKE) -C html dist diff -Nru texworks-manual-20200329/debian/patches/series texworks-manual-20210308/debian/patches/series --- texworks-manual-20200329/debian/patches/series 2021-01-31 10:26:16.000000000 +0100 +++ texworks-manual-20210308/debian/patches/series 1970-01-01 01:00:00.000000000 +0100 @@ -1 +0,0 @@ -#fix-build-lang diff -Nru texworks-manual-20200329/debian/texworks-help-en.doc-base texworks-manual-20210308/debian/texworks-help-en.doc-base --- texworks-manual-20200329/debian/texworks-help-en.doc-base 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/debian/texworks-help-en.doc-base 2021-07-14 21:38:06.000000000 +0200 @@ -0,0 +1,10 @@ +Document: texworks-help-en-manual +Title: A short manual for TEXworks +Author: Alain Delmotte, Stefan Löffler +Abstract: English help files for TeXworks + This is the manual for program suite TeXworks (English). + For further information, see http://tug.org/texworks/ +Section: Text + +Format: PDF +Files: /usr/share/doc/texworks-help-en/manual.pdf diff -Nru texworks-manual-20200329/debian/texworks-help-fr.doc-base texworks-manual-20210308/debian/texworks-help-fr.doc-base --- texworks-manual-20200329/debian/texworks-help-fr.doc-base 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/debian/texworks-help-fr.doc-base 2021-07-14 21:38:06.000000000 +0200 @@ -0,0 +1,10 @@ +Document: texworks-help-fr-manuel +Title: A short manual for TEXworks +Author: Alain Delmotte, Stefan Löffler +Abstract: French help files for TeXworks + This is the manual for program suite TeXworks (French). + For further information, see http://tug.org/texworks/ +Section: Text + +Format: PDF +Files: /usr/share/doc/texworks-help-fr/manuel.pdf diff -Nru texworks-manual-20200329/debian/upstream/metadata texworks-manual-20210308/debian/upstream/metadata --- texworks-manual-20200329/debian/upstream/metadata 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/debian/upstream/metadata 2021-07-14 21:38:06.000000000 +0200 @@ -0,0 +1,3 @@ +--- +Bug-Database: https://github.com/TeXworks/manual/issues +Bug-Submit: https://github.com/TeXworks/manual/issues/new diff -Nru texworks-manual-20200329/.github/actions/deploy-launchpad/action.yml texworks-manual-20210308/.github/actions/deploy-launchpad/action.yml --- texworks-manual-20200329/.github/actions/deploy-launchpad/action.yml 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/deploy-launchpad/action.yml 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1,33 @@ +name: 'Deploy to Launchpad' +author: 'Stefan Löffler' +description: 'Upload packages to Launchpad PPAs' + +inputs: + changes_files: + description: 'space-separated list of paths to .changes files to upload' + required: true + devel-repo: + description: 'PPA to upload development versions to (e.g., ppa:testuser/nighlies)' + required: true + stable-repo: + description: 'PPA to upload releases (tags) to (e.g., ppa:testuser/stable)' + required: true + +runs: + using: composite + steps: + - run: | + case "${GITHUB_REF}" in + refs/tags/*) + REPO="${{ inputs.stable-repo }}" + ;; + *) + REPO="${{ inputs.devel-repo }}" + ;; + esac + for FILE in ${{ inputs.changes_files }}; do + echo "::group::Uploading ${FILE}" + dput ${REPO} "$FILE" + echo "::endgroup::" + done + shell: bash diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/action.yml texworks-manual-20210308/.github/actions/package-launchpad/action.yml --- texworks-manual-20200329/.github/actions/package-launchpad/action.yml 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/action.yml 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1,43 @@ +name: 'Package TeXworks for Launchpad' +author: 'Stefan Löffler' +description: '' + +inputs: + DEB_PASSPHRASE: + description: 'Passphrase to unlock the debian signing key' + required: true + DECRYPTION_KEY: + description: 'Passphrase to decrypt the debian signing key' + required: true + +outputs: + changes_files: + description: 'The paths to the .changes files produced' + value: ${{ steps.package.outputs.CHANGES }} + +runs: + using: composite + steps: + - run: | + echo "::group::Install dependencies" + sudo apt update && sudo apt install --assume-yes --no-install-recommends ubuntu-dev-tools debhelper dput + echo "::endgroup::" + echo "::group::Import signing keys" + mkdir -p "${HOME}/.gnupg" + chmod 700 "${HOME}/.gnupg" + echo '${{ inputs.DECRYPTION_KEY }}' | gpg --quiet --batch --yes --decrypt --passphrase-fd=0 ${{ github.action_path }}/launchpad/key.asc.gpg | gpg --batch --import + echo "::endgroup::" + shell: bash + - id: get-ubuntu-series + run: echo "::set-output name=SERIES::$(python3 ${{ github.action_path }}/get-ubuntu-series.py)" + shell: bash + - id: package + run: ${{ github.action_path }}/package.sh + shell: bash + working-directory: ${{ github.workspace }} + env: + PREV_COMMIT: ${{ github.event.before }} + DEB_MAINTAINER_NAME: "Stefan Löffler" + DEB_MAINTAINER_EMAIL: "st.loeffler@gmail.com" + LAUNCHPAD_SERIES: ${{ steps.get-ubuntu-series.outputs.SERIES }} + DEB_PASSPHRASE: ${{ inputs.DEB_PASSPHRASE }} diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/get-ubuntu-series.py texworks-manual-20210308/.github/actions/package-launchpad/get-ubuntu-series.py --- texworks-manual-20200329/.github/actions/package-launchpad/get-ubuntu-series.py 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/get-ubuntu-series.py 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1,5 @@ +import json, urllib.request + +with urllib.request.urlopen('https://api.launchpad.net/1.0/ubuntu/series') as www: + dat = json.loads(www.read()) +print(' '.join([e['name'] for e in dat['entries'] if e['active']])) diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/compat texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/compat --- texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/compat 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/compat 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1 @@ +9 diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/control texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/control --- texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/control 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/control 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1,28 @@ +Source: texworks-help +Section: tex +Priority: optional +Maintainer: Stefan Löffler <st.loeffler@gmail.com> +Build-Depends: debhelper (>= 9), texlive-latex-base, texlive-latex-extra, texlive-luatex, tex4ht, texlive-fonts-recommended, lmodern, texlive-lang-french, ghostscript, imagemagick, netpbm, zip, tidy +Standards-Version: 3.9.2 +Homepage: https://github.com/TeXworks/manual +Vcs-Git: https://github.com/TeXworks/manual.git +Vcs-Browser: https://github.com/TeXworks/manual + +Package: texworks-help-en +Architecture: all +Recommends: texworks +Description: English help files for TeXworks, a simple interface for working + with TeX documents. + . + For further information, see https://github.com/TeXworks/manual/ or + http://tug.org/texworks/ + +Package: texworks-help-fr +Architecture: all +Recommends: texworks +Description: French help files for TeXworks, a simple interface for working + with TeX documents. + . + For further information, see https://github.com/TeXworks/manual/ or + http://tug.org/texworks/ + diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/copyright texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/copyright --- texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/copyright 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/copyright 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1,22 @@ +This package was debianized by <AUTHOR> on <DATE> + +It was downloaded from https://github.com/TeXworks/manual/ + +Upstream Authors: + + Alain Delmotte, Stefan Löffler, and others + +Copyright: + + Copyright (C) 2009 Alain Delmotte + +License: + + You are free to distribute this software under the terms of + the GNU General Public License version 2. + On Debian systems, the complete text of the GNU General Public + License v2 can be found in the file `/usr/share/common-licenses/GPL-2'. + +The Debian packaging is copyright 2020, Stefan Löffler <st.loeffler@gmail.com> and +is licensed under the GPLv2, see `/usr/share/common-licenses/GPL-2'. + diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/rules texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/rules --- texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/rules 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/rules 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1,21 @@ +#!/usr/bin/make -f + +export DH_VERBOSE=1 +export TEXMFCACHE=/tmp/texmf-var + +.PHONY : TeXdirs + +%: + dh $@ + +override_dh_auto_build-indep: TeXdirs + $(MAKE) + +override_dh_auto_install-indep: + $(MAKE) dist + +override_dh_auto_clean: + $(MAKE) dist-clean + +TeXdirs: + mkdir -p "$TEXMFCACHE" diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/source/format texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/source/format --- texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/source/format 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/source/format 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1 @@ +3.0 (quilt) diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/texworks-help-en.install texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/texworks-help-en.install --- texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/texworks-help-en.install 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/texworks-help-en.install 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1 @@ +html/TeXworks-manual/en/* /usr/share/doc/texworks-help/Manual/en diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/texworks-help-fr.install texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/texworks-help-fr.install --- texworks-manual-20200329/.github/actions/package-launchpad/launchpad/debian/texworks-help-fr.install 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/launchpad/debian/texworks-help-fr.install 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1 @@ +html/TeXworks-manual/fr/* /usr/share/doc/texworks-help/Manual/fr diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/launchpad/.gitattributes texworks-manual-20210308/.github/actions/package-launchpad/launchpad/.gitattributes --- texworks-manual-20200329/.github/actions/package-launchpad/launchpad/.gitattributes 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/launchpad/.gitattributes 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1 @@ +*.gpg -text Binary files /tmp/IL9Tq3fCZJ/texworks-manual-20200329/.github/actions/package-launchpad/launchpad/key.asc.gpg and /tmp/ul6Pv8fpMo/texworks-manual-20210308/.github/actions/package-launchpad/launchpad/key.asc.gpg differ diff -Nru texworks-manual-20200329/.github/actions/package-launchpad/package.sh texworks-manual-20210308/.github/actions/package-launchpad/package.sh --- texworks-manual-20200329/.github/actions/package-launchpad/package.sh 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/actions/package-launchpad/package.sh 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1,127 @@ +#!/usr/bin/env sh + +# Exit on errors +set -e + +UNSUPPORTED_SERIES="precise" + +print_error() { + echo "::error file=${0}::${1}" +} +print_warning() { + echo "::warning file=${0}::${1}" +} +echo_var () { + # echo "$1 = ${!1}" does not work in dash (Ubuntu's default sh) + eval "echo \"$1 = \$$1\"" +} + +# Gather information + +echo "::group::Info" + +GIT_HASH=$(git --git-dir=".git" show --no-patch --pretty="%h") +echo "GIT_HASH = ${GIT_HASH}" + +DATE_HASH=$(date -u +"%Y%m%d%H%M") +echo "DATE_HASH = ${DATE_HASH}" + +DEBDATE=$(date -R) + +echo_var "DEBDATE" +echo_var "DEB_MAINTAINER_NAME" +echo_var "DEB_MAINTAINER_EMAIL" +echo_var "LAUNCHPAD_SERIES" + +echo "::endgroup::" + +if [ -z "${DEB_MAINTAINER_NAME}" -o -z "${DEB_MAINTAINER_EMAIL}" -o -z "${DEB_PASSPHRASE}" -o -z "${LAUNCHPAD_SERIES}" ]; then + print_error "DEB_MAINTAINER_NAME and/or DEB_MAINTAINER_EMAIL and/or DEB_PASSPHRASE and/or LAUNCHPAD_SERIES are not set" + exit 1 +fi + +PACKAGE_NAME="texworks-help" +VERSION="0.1.1" +BUILDDIR="launchpad-build" +ORIG_VERSION="${VERSION}~${DATE_HASH}~git~${GIT_HASH}" +ORIGNAME="${PACKAGE_NAME}_${ORIG_VERSION}" +ORIGFILENAME="${ORIGNAME}.orig.tar.gz" + +echo " exporting sources to ${BUILDDIR}/${ORIGFILENAME}" +mkdir "${BUILDDIR}" +git archive --prefix="${ORIGNAME}/" --output="${BUILDDIR}/${ORIGFILENAME}" HEAD + +TOPDIR=$(pwd) + +OUTPUT_FILES="" + +for SERIES in ${LAUNCHPAD_SERIES}; do + SUPPORTED=1 + for US in ${UNSUPPORTED_SERIES}; do + if [ "${SERIES}" = "${US}" ]; then SUPPORTED=0; fi + done + if [ ${SUPPORTED} -eq 0 ]; then + echo "Skipping ${SERIES} - unsupported" + continue + fi + + echo "::group::Packaging for ${SERIES}" + DEB_VERSION="${ORIG_VERSION}-1${SERIES}" + echo_var "DEB_VERSION" + + DEBDIR="${BUILDDIR}/${PACKAGE_NAME}_${DEB_VERSION}" + echo "exporting sources to ${DEBDIR}" + mkdir -p "${DEBDIR}" + tar -x -C "${DEBDIR}" --strip-components=1 -f "${BUILDDIR}/${ORIGFILENAME}" + + echo "copying debian directory" + cp -r ".github/actions/package-launchpad/launchpad/debian" "${DEBDIR}" + + PATCHFILE=".github/actions/package-launchpad/launchpad/${SERIES}.patch" + if [ -f "${PATCHFILE}" ]; then + echo " applying ${SERIES}.patch" + patch -d "${DEBDIR}" -p0 < "${PATCHFILE}" + fi + + + echo "preparing copyright" + sed -i -e "s/<AUTHOR>/${DEB_MAINTAINER_NAME}/g" -e "s/<DATE>/${DEBDATE}/g" "${DEBDIR}/debian/copyright" + + echo "preparing changelog" + printf "${PACKAGE_NAME} (${DEB_VERSION}) ${SERIES}; urgency=low\n\n" > "${DEBDIR}/debian/changelog" + case "${GITHUB_REF}" in + refs/tags/*) + NEWS=$(sed -n "/^Release ${VERSION}/,/^Release/p" "NEWS" | sed -e '/^Release/d' -e 's/^\t/ /') + echo "$NEWS" >> "${DEBDIR}/debian/changelog" + ;; + *) + git log --reverse --pretty=format:"%w(80,4,6)* %s" "${PREV_COMMIT}.." >> "${DEBDIR}/debian/changelog" + echo "" >> "${DEBDIR}/debian/changelog" # git log does not append a newline + ;; + esac + printf "\n -- ${DEB_MAINTAINER_NAME} <${DEB_MAINTAINER_EMAIL}> ${DEBDATE}\n" >> "${DEBDIR}/debian/changelog" + + echo "building package" + echo "" + cd "${DEBDIR}" + + PASSPHRASE_FILE="${TOPDIR}/passphrase.txt" + touch "${PASSPHRASE_FILE}" + chmod 600 "${PASSPHRASE_FILE}" + echo "${DEB_PASSPHRASE}" > "${TOPDIR}/passphrase.txt" || print_error "Failed to create passphrase.txt" + debuild -k8740ED04AF6A4FCC6BC51C426806F10000582F84 -p"gpg --no-tty --batch --pinentry-mode=loopback --passphrase-file ${PASSPHRASE_FILE}" -d -S && DEBUILD_RETVAL=$? || DEBUILD_RETVAL=$? + rm -f "${PASSPHRASE_FILE}" + + if [ $DEBUILD_RETVAL -ne 0 ]; then + print_warning " debuild failed with status code ${DEBUILD_RETVAL}" + continue + fi + cd "${TOPDIR}" + + OUTPUT_FILES="${BUILDDIR}/${PACKAGE_NAME}_${DEB_VERSION}_source.changes ${OUTPUT_FILES}" + echo "::endgroup::" +done + +echo "::set-output name=CHANGES::${OUTPUT_FILES}" + +echo "Packaging completed" diff -Nru texworks-manual-20200329/.github/workflows/ci.yml texworks-manual-20210308/.github/workflows/ci.yml --- texworks-manual-20200329/.github/workflows/ci.yml 1970-01-01 01:00:00.000000000 +0100 +++ texworks-manual-20210308/.github/workflows/ci.yml 2021-03-08 17:33:22.000000000 +0100 @@ -0,0 +1,42 @@ +name: CI +on: + - push + - pull_request + +jobs: + texlive: + name: TeXLive (Ubuntu) + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Install dependencies + run: sudo apt install --assume-yes --no-install-recommends ghostscript imagemagick lmodern netpbm tex4ht texlive-fonts-recommended texlive-lang-french texlive-latex-base texlive-latex-extra texlive-luatex tidy + + - name: Typeset + run: make dist + + - name: Upload artifacts + uses: actions/upload-artifact@v2 + with: + path: | + pdf/**/*.pdf + html/*.zip + + - name: Package (Launchpad) + id: package-launchpad + uses: ./.github/actions/package-launchpad + with: + DEB_PASSPHRASE: ${{ secrets.DEB_PASSPHRASE }} + DECRYPTION_KEY: ${{ secrets.DECRYPTION_KEY }} + + - name: Deploy (Launchpad) + if: github.event_name == 'push' + uses: ./.github/actions/deploy-launchpad + with: + changes_files: ${{ steps.package-launchpad.outputs.changes_files }} + devel-repo: "ppa:texworks/ppa" + stable-repo: "ppa:texworks/stable" diff -Nru texworks-manual-20200329/src/en/backmatter.tex texworks-manual-20210308/src/en/backmatter.tex --- texworks-manual-20200329/src/en/backmatter.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/backmatter.tex 2021-03-08 17:33:22.000000000 +0100 @@ -6,7 +6,7 @@ Microsoft, Windows, and the Windows logo are registered trademarks of Microsoft Corporation in the United States and other countries. -Apple, Mac, and Mac OS are trademarks of Apple Inc., registered in the U.S. and other countries. +Apple, Mac, and macOS are trademarks of Apple Inc., registered in the U.S. and other countries. GitHub is a trademark of GitHub Inc. diff -Nru texworks-manual-20200329/src/en/customizing.tex texworks-manual-20210308/src/en/customizing.tex --- texworks-manual-20200329/src/en/customizing.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/customizing.tex 2021-03-08 17:33:22.000000000 +0100 @@ -43,7 +43,7 @@ The use of keyboard shortcuts\index{keyboard shortcuts} greatly facilitates typing in and the management of the source and the preview windows. Their use is much more effective than the use of buttons for frequently-used actions. -Below, you'll find the shortcuts for source and preview windows. Note that on Mac OS X, \verb|Ctrl| actually refers to the \emph{Command key}, which is the usual modifier for keyboard shortcuts. Although the keyboard shortcuts are specified with \verb|Ctrl|, this will appear as the \emph{Command-key} symbol in menus. (To refer to the actual \emph{Control key} on the Mac, the shortcut file should use the name \verb|Meta|). +Below, you'll find the shortcuts for source and preview windows. Note that on macOS, \verb|Ctrl| actually refers to the \emph{Command key}, which is the usual modifier for keyboard shortcuts. Although the keyboard shortcuts are specified with \verb|Ctrl|, this will appear as the \emph{Command-key} symbol in menus. (To refer to the actual \emph{Control key} on the Mac, the shortcut file should use the name \verb|Meta|). Note that the shortcuts listed below are the default shortcuts for the English interface of {\Tw}. Different languages may use different shortcuts. @@ -107,8 +107,11 @@ For the preview window: \input menuactionsPDFDocument.tex -\subsection{Other actions} -In addition to the static actions listed above, there are also actions for scripts. These are dynamic in nature, as they are created on-the-fly for the available scripts (which may change when you install scripts, remove them, or change some settings). All of these actions are of the form \verb*|Script: <script_title>|, where \verb*|<script_title>| must be replaced appropriately. If you have a script that shows up as \verb|My Script|, for example, the corresponding action would be named \verb*|Script: My Script|. +\subsection{Actions for typesetting tools} +In addition to the static actions listed above, there are also actions for switching to a typesetting tool. All of these actions are of the general form \verb*|actionTypesetTool<tool_name>| where \verb*|<tool_name>| must be replaced appropriately. For example, the name corresponding to the \verb*|pdfLaTeX| typesetting tool is \verb*|actionTypesetToolpdfLaTeX|, that corresponding to \verb*|My tool| is \verb*|actionTypesetToolMy tool|.\footnote{Note that some characters (such as \verb*|=| and \verb*|;| are reserved in ini files and must be escaped by \verb*|%XX|, where \verb*|XX| is the corresponding hexadecimal ASCII code. For example, the name corresponding to \verb*|A=B| is \verb*|actionTypesetToolA%3DB|.} + +\subsection{Actions for scripts} +There are also actions for scripts. These are dynamic in nature, as they are created on-the-fly for the available scripts (which may change when you install scripts, remove them, or change some settings). All of these actions are of the form \verb*|Script: <script_title>|, where \verb*|<script_title>| must be replaced appropriately. If you have a script that shows up as \verb|My Script|, for example, the corresponding action would be named \verb*|Script: My Script|. \section{Roots for completion} diff -Nru texworks-manual-20200329/src/en/editingtools.tex texworks-manual-20210308/src/en/editingtools.tex --- texworks-manual-20200329/src/en/editingtools.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/editingtools.tex 2021-03-08 17:33:22.000000000 +0100 @@ -10,7 +10,7 @@ Most documents you will create will use the same instructions in the preamble, the same layout settings, similar heading and so on. You can use predefined templates to get started quickly or create your own with all of these settings already in place. -Use \menu{File}\submenu\menu{New from template\ldots} or \keysequence{Ctrl+Shift+N} (Mac OS X: \keysequence{Cmd+Shift+N}). A dialogue box opens to allow you to select one of the templates. After selecting one and pressing \verb|OK|, a document is created and you can start to work. +Use \menu{File}\submenu\menu{New from template\ldots} or \keysequence{Ctrl+Shift+N} (macOS: \keysequence{Cmd+Shift+N}). A dialogue box opens to allow you to select one of the templates. After selecting one and pressing \verb|OK|, a document is created and you can start to work. If you want to create a personal template, you just have to create a suitable document with everything you always want to do (and perhaps marking places to fill in the rest) and save it as a \path{.tex} file in the \path{<resources>\templates} folder, or a sub-folder of it, if you wish. @@ -53,7 +53,7 @@ \subsection{Standard functions} -The options of the menu \menu{Search}---\menu{Find\dots}, \menu{Find again}, \menu{Replace\dots}, \menu{Replace again}, and \menu{Go to Line\dots} (\keysequence{Ctrl+F}, \keysequence{Ctrl+G}, \keysequence{Ctrl+R}, \keysequence{Ctrl+Shift+R}, and \keysequence{Ctrl+L}, respectively)---are standard actions (Mac OS X: \keysequence{Cmd+F}, \keysequence{Cmd+G}, \keysequence{Cmd+R}, \keysequence{Cmd+Shift+R}, and \keysequence{Cmd+L}); the first and the third open a dialogue box: +The options of the menu \menu{Search}---\menu{Find\dots}, \menu{Find again}, \menu{Replace\dots}, \menu{Replace again}, and \menu{Go to Line\dots} (\keysequence{Ctrl+F}, \keysequence{Ctrl+G}, \keysequence{Ctrl+R}, \keysequence{Ctrl+Shift+R}, and \keysequence{Ctrl+L}, respectively)---are standard actions (macOS: \keysequence{Cmd+F}, \keysequence{Cmd+G}, \keysequence{Cmd+R}, \keysequence{Cmd+Shift+R}, and \keysequence{Cmd+L}); the first and the third open a dialogue box: \begin{center} \includegraphics[scale=.6]{replaceDialog} @@ -113,11 +113,11 @@ \subsection{Standard tools} -It is always possible to undo\index{editing!undo} an action using \menu{Edit}\submenu\menu{Undo} or \keysequence{Ctrl+Z} (Mac OS X: \keysequence{Cmd+Z}): this way you can undo stepwise! The inverse action, redo, is available as \menu{Edit}\submenu\menu{Redo}\index{editing!redo} or \keysequence{Ctrl+Shift+Z} (Mac OS X: \keysequence{Cmd+Shift+Z}).\footnote{\keysequence{Ctrl+Y} and \keysequence{Alt+Shift+Backspace} work as well on Windows. \keysequence{Cmd+Y} work as well on Mac OS X.} +It is always possible to undo\index{editing!undo} an action using \menu{Edit}\submenu\menu{Undo} or \keysequence{Ctrl+Z} (macOS: \keysequence{Cmd+Z}): this way you can undo stepwise! The inverse action, redo, is available as \menu{Edit}\submenu\menu{Redo}\index{editing!redo} or \keysequence{Ctrl+Shift+Z} (macOS: \keysequence{Cmd+Shift+Z}).\footnote{\keysequence{Ctrl+Y} and \keysequence{Alt+Shift+Backspace} work as well on Windows. \keysequence{Cmd+Y} work as well on macOS.} {\Tw} also provides the standard editing tools such as the clipboard; therefore one can select, cut/copy and paste a piece of text normally. -You can select with the mouse by dragging over the desired text, or by double-clicking to select a word. Using the keyboard, holding down \keysequence{Shift} while moving using the arrow keys will select text. You can also move and select word by word moving left or right holding \keysequence{Ctrl+Shift} down (\keysequence{Cmd+Shift} on Mac OS X). The clipboard shortcuts are the ones you'll find in almost every program: \keysequence{Ctrl+X} to cut, \keysequence{Ctrl+C} to copy, and \keysequence{Ctrl+V} to paste (\keysequence{Cmd+X}, \keysequence{Cmd+C} and \keysequence{Cmd+V}, respectively, on Mac OS X). +You can select with the mouse by dragging over the desired text, or by double-clicking to select a word. Using the keyboard, holding down \keysequence{Shift} while moving using the arrow keys will select text. You can also move and select word by word moving left or right holding \keysequence{Ctrl+Shift} down (\keysequence{Cmd+Shift} on macOS). The clipboard shortcuts are the ones you'll find in almost every program: \keysequence{Ctrl+X} to cut, \keysequence{Ctrl+C} to copy, and \keysequence{Ctrl+V} to paste (\keysequence{Cmd+X}, \keysequence{Cmd+C} and \keysequence{Cmd+V}, respectively, on macOS). You can easily change the case\index{editing!change case} of a selection---put everything upper case or lower case---using \menu{Edit}\submenu\menu{Change case} and next, depending on the desired effect, \menu{ALL UPPERCASE}, \menu{all lowercase}, or \menu{Toggle Case} (which toggles the case of each letter individually). @@ -128,11 +128,11 @@ When preparing a document with {\AllTeX}, it is often useful to prevent compilation of a portion of text to be able to locate an error; you can do this piece by piece until you find the part which causes the error. For that, commenting the source block by block is needed. We have seen that the symbol \verb+%+ marks the beginning of a comment. -To comment\index{editing!comment} a big piece of text, it is sufficient to select it and ask to mark it as comment \menu{Format}\submenu\menu{Comment} or \keysequence{Ctrl+Shift+]} (Mac OS X: \keysequence{Cmd+Shift+]}). To remove the comment, select the lines and choose \menu{Format}\submenu\menu{Uncomment}\index{editing!uncomment} or \keysequence{Ctrl+Shift+[} (Mac OS X: \keysequence{Cmd+Shift+[}).\footnote{On some keyboards, like the French one, it is impossible to use \keysequence{Ctrl+Shift+[} or \keysequence{Ctrl+Shift+]}; these shortcuts can be changed, however---see section \ref{sec.shortcuts}} +To comment\index{editing!comment} a big piece of text, it is sufficient to select it and ask to mark it as comment \menu{Format}\submenu\menu{Comment} or \keysequence{Ctrl+Shift+]} (macOS: \keysequence{Cmd+Shift+]}). To remove the comment, select the lines and choose \menu{Format}\submenu\menu{Uncomment}\index{editing!uncomment} or \keysequence{Ctrl+Shift+[} (macOS: \keysequence{Cmd+Shift+[}).\footnote{On some keyboards, like the French one, it is impossible to use \keysequence{Ctrl+Shift+[} or \keysequence{Ctrl+Shift+]}; these shortcuts can be changed, however---see section \ref{sec.shortcuts}} \subsection{Matching delimiters} -A frequent error is to forget a closing symbol: parenthesis, bracket, square bracket, \emph{etc}. {\Tw} helps with a tool to show the pairs of symbols: when the cursor moves over one of these symbols, its partner is briefly highlighted. You can also select an entire block\index{editing!select a block} using \menu{Edit}\submenu\menu{Balance Delimiters} or by the shortcut \keysequence{Ctrl+B} (Mac OS X: \keysequence{Cmd+B}). Thus, you will immediately see the scope of the block. +A frequent error is to forget a closing symbol: parenthesis, bracket, square bracket, \emph{etc}. {\Tw} helps with a tool to show the pairs of symbols: when the cursor moves over one of these symbols, its partner is briefly highlighted. You can also select an entire block\index{editing!select a block} using \menu{Edit}\submenu\menu{Balance Delimiters} or by the shortcut \keysequence{Ctrl+B} (macOS: \keysequence{Cmd+B}). Thus, you will immediately see the scope of the block. \subsection{Smart quotes} diff -Nru texworks-manual-20200329/src/en/firststeps.tex texworks-manual-20210308/src/en/firststeps.tex --- texworks-manual-20200329/src/en/firststeps.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/firststeps.tex 2021-03-08 17:33:22.000000000 +0100 @@ -1,185 +1,185 @@ -% !TEX encoding = UTF8 -% !TEX root = manual.tex -% !TEX spellcheck = en_UK - -\chapter{First steps} -\label{chap:first-steps} - -Let's now see how to create a first document: for this you'll need to type some text in the editor window of {\Tw}. {\AllTeX} is \emph{not} WYSIWYG\index{WYSIWYG}\footnote{\emph{What You See Is What You Get}.} software, so you'll have to type the text and the instructions for formatting it and you'll see the result only after ``typesetting'' the text. This looks a little bit dry, but one very quickly gets used to it and it is well worth the effort. - -\section{Interface summary}\index{interface} - -\newsavebox{\inlineimg} -\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar1}\hspace{1em}} - -When one opens the editor, it shows a very sparse interface: a title bar, a menu bar, two small toolbars\index{toolbar}, a large typing zone (white) and, at the bottom, a status bar. We are in the \emph{source/editor\index{source/editor}} window. If you have already typeset the document previously, the resulting \path{.pdf} will be shown on the right hand side in the \emph{preview}\index{preview} window. -\vspace{10pt} - -\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar1}\hspace{.5em}} -%\begin{wrapfigure}[2]{l}{\widthof{\usebox{\inlineimg}}} -\begin{wrapfigure}[2]{l}{90pt} -\vspace*{-1em} -\usebox{\inlineimg} -\end{wrapfigure} -\noindent The first toolbar has a button to typeset and an drop-down menu to choose the format for typesetting (we'll choose \verb+pdfLaTeX+). Knowing that the keyboard shortcut for typesetting is \keysequence{Ctrl+T} (Mac OS X: \keysequence{Cmd+T}) and that we almost never change the format, we could even hide this toolbar. The selection of a format for compiling can also be changed through the \menu{Typeset}\index{typeset} menu. -\vspace{10pt} - -%\includegraphics[scale=.6]{toolbar2}\hspace{10pt}% -\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar2}\hspace{.5em}} -%\begin{wrapfigure}[2]{l}{\widthof{\usebox{\inlineimg}}} -\begin{wrapfigure}[2]{l}{160pt} -\vspace*{-1em} -\usebox{\inlineimg} -\end{wrapfigure} -\noindent The second toolbar provides the standard functions: New document, Open, Save | Undo, Redo | Cut, Copy, Paste | Search, Replace. - -\begin{center} -\includegraphics[width=\textwidth]{interface-summary} -\end{center} - -Even though they are not looking like real buttons, the widgets in the status bar can be clicked. The widgets showing the current position (line or page, respectively), for example, open a dialog to enter a line or page to jump to when clicked. The other widgets typically open contextual menus where some settings can be changed. - -\section{Creating a document} - -\subsection{Writing the document} - -As an example of the use of {\Tw}, we will work with \LaTeX\index{TeX@\TeX!\LaTeX}, but any other {\TeX} system is possible. In particular, if you need to use some special fonts\footnote{You can only use fonts {\AllTeX} knows, most of which are coming in packages included in your distribution. You cannot use your ``normal'' fonts, unfortunately. For more information, see for example \url{http://faq.tug.org/} and \url{http://www.tug.dk/FontCatalogue/}.}---a mandatory font for an official template, non-Latin alphabets, etc.---the {\XeTeX} system is very powerful.\footnote{See the bibliography for pointers to {\XeTeX} and \XeLaTeX.} - -Let's create our first document\index{document!creation} now. Enter the following text exactly as shown. To show some of the features of {\Tw}/{\LaTeX}, it is in French intentionally. - -\begin{example} -\documentclass{article} - -\usepackage[utf8]{inputenc} -\usepackage[T1]{fontenc} -\usepackage{geometry} -\geometry{a4paper} - -\usepackage[frenchb]{babel} - -\title{Premier document} -\author{Un TeXnicien} -\date{} - -\begin{document} -\maketitle - -Voici un texte accentué en français! - -\end{document} -\end{example} - -Save the file in a folder for test documents (e.g., \path{<home>\TeXworks_tests}); call the file \path{first.tex}. Note that it should have a \path{.tex} extension\index{extension .tex}. - -\subsection{Typesetting the document and viewing it} - -Next we start typesetting\index{document!typesetting}\footnote{We also use the words ``compilation'' and ``to compile'' for the same action; indeed {\LaTeX} works on the source file to produce a \path{.pdf} output, so there is a compilation.} by clicking the green button \raisebox{-2pt}{\includegraphics{iconTypeset}} -or by \keysequence{Ctrl+T}\index{Ctrl+T|texttt} (Mac OS X: \keysequence{Cmd+T}). - -A new panel opens between the typing area and the status bar: the \emph{output panel\index{output panel}}, labeled \emph{Log\index{log}}; everything {\LaTeX} is doing is displayed there\footnote{see page \pageref{fig:consoleOutput} for a picture of the panel}. When {\LaTeX} finishes this panel disappears (if there no error occurred) and a new window will appear; in this new window, the \emph{Preview window\index{preview window}}\index{document!previewing}, you can see a page with a title \foreignlanguage{french}{``Premier document''} followed by the name of the author \foreignlanguage{french}{``Un TeXnicien''}, both centred, the text -\foreignlanguage{french}{``Voici un texte accentué en français!''}, and a page number at the bottom centre. - -Notice that the mouse cursor is like a magnifier in the new window. If you press (and hold) the left button of the mouse you can see the text under the magnifier much bigger (it is a magnifier, isn't it!); you can move the magnifier and so inspect the text in detail. - -To go back to the source, you can just click in its window or better use \keysequence{Ctrl+'}\index{Ctrl+'|texttt} (Mac OS X \keysequence{Cmd+'}). This shortcut toggles between the two windows. See also section \ref{sec.synctex} to automatically move to a specific location in the output from the source or vice versa. - -\subsection{The work of \LaTeX} - -Let's shortly analyse the result to understand what \LaTeX{} did and why, now. Introductions and full tutorials can be found on the internet: see for example \emph{lshort}\footnote{\emph{The (Not So) Short Introduction to \LaTeXe}} which should be installed as part of your {\TeX} distribution, and is also available from CTAN\index{CTAN}.\footnote{\emph{Comprehensive TeX Archives Network}, a network of mirror servers of the central CTAN; there, one can find almost everything about {\TeX}, {\LaTeX}, and more: \url{http://www.ctan.org}} - -First, we ask to create a document of the \emph{article} class: this defines the global layout of the document. - -Next, we say that the input document (the source) is saved with the Unicode encoding \emph{utf-8\index{encoding!utf-8}\index{utf-8|see{encoding, utf-8}}} and that it may contain characters which are not present in the standard ASCII without accents. We also want to use an output encoding T1 (the modern {\TeX} encoding); we also want an \emph{A4} document and not the default \emph{US letter} size. Finally, we make it clear that the typography should follow the French rules using the \textbf{\textsf{babel}} package.\footnote{This influences, e.g., automatic hyphenation of words or the way punctuation characters are typeset} Those general instructions for the work are done by packages\index{packages} called with options. - -Lastly, we finish the declaration part of the document, the \emph{preamble}\index{preamble}, giving the title, the author, and the date of the document; here we specify no date. - -Next comes the body of the document, which describes the actual content, between the lines \verb+\begin{document}+ and \verb+\end{document}+ (these are {\LaTeX} commands). - -Let's do some experiments to show the effect of these instructions. For this, we put a \% in front of the instructions; the \% and everything after it will be considered as comment\index{comments}, which will be ignored by {\LaTeX}.\footnote{Notice that the comments are, by default (this can be changed), coloured red by {\Tw}, so we see them well.} - -Comment out the line \verb|\usepackage[utf8]{inputenc}|, and typeset the file. You should see that the accented characters are now displayed incorrectly in the preview window. If, in addition, you also comment out the line \verb|\usepackage[frenchb]{babel}|, {\LaTeX} will give an error. Just hit \Return to continue the typesetting. - -%Comment out the line \verb|\usepackage[utf8]{inputenc}|, and typeset the file. You should see that the accented characters are now incorrect in the preview window. If you now comment out the line \verb|\usepackage[french]{babel}|, {\LaTeX} will give an error. Just hit \Return to continue the typesetting. - -\needspace{3\baselineskip} -After these experiments, let's modify the text as follows: -\begin{example} -\begin{document} -\maketitle -\tableofcontents - -\section{Petite démonstration} - -Voici un texte accentué en français! -Suite du texte entré après avoir fait un retour chariot. Dans -l'éditeur on peut demander un passage automatique à la ligne -du texte saisi; mais le numéro de ligne n'est incrémenté que par un -retour chariot. - -Nouvelle ligne en passant une ligne dans la source: c'est la -manière d'indiquer un changement de paragraphe. - -\end{document} -\end{example} -Redo the previous experiments and observe the changes which appear. - -Note that entering only one carriage return doesn't create a new paragraph. In {\LaTeX}, one has to have an empty line for that. In {\Tw}, the line number of the source (on the right in the status bar) numbers the lines created with carriage return, not the wrapped lines. - -\section{And when errors occur?}\index{errors} - -When you create a document for typesetting with {\LaTeX}, you cannot avoid making mistakes: forgetting a closing brace or an \verb|\end{}| to close an environment, using mathematical commands without switching to mathematical mode, etc. When you compile and there is an error, {\LaTeX} stops, giving you a chance to deal with the problem. This is shown by the stopping of the scrolling action in the output panel, and an error message being displayed, with {\LaTeX} waiting for an instruction to know what it should do. - -\begin{center}\label{fig:consoleOutput} -\includegraphics{consoleOutput} -\end{center} - -One sees the \emph{typing cursor\index{typing cursor}} in the line between the output panel and the status bar: the \emph{console bar\index{console bar}}. - -The error message is on many lines, for example like this: -\smallskip - -\begin{verbExample} -! Undefined control sequence. -l.168 ... fermante ou d'une commande \veb - +\end{}+ de fermeture d'un... -? -\end{verbExample} - -{\LaTeX} says that it doesn't recognize the command name, sometimes suggests to see the manual or to type \verb|h| (plus \Return) for help, points to the line number where it noticed the error\footnote{Unfortunately, this does not always have to be the place where the actual mistake was made in the sources. This is discussed later.} (here 168), and shows the place of the error at the cut of the line (here at \verb|\veb|). Finally, it shows that it waits for an action from us by displaying a single question mark. - -There are different possible actions: -\begin{itemize} -\item Type \Return and ask to continue as if nothing happened; sometimes this allows to finish compiling, but there will be an error in the result. -\item Type \verb+h+\Return to ask for help; this help is not always clearer than the error message, but often gives a clue. -\item Type \verb+i+\Return to tell {\LaTeX} that we will propose a replacement text. Enter the text followed by \Return; it will be used, beginning at the start of the error, but you should correct the source afterwards as {\LaTeX} never changes that. -\item Type \verb+x+\Return to stop compilation. This is the traditional {\AllTeX} way to kill a typesetting process. - -We can also kill the typesetting by repeating the action used to start it: the green typesetting button will have changed to a red one with a white cross \raisebox{-2pt}{\includegraphics[scale=.8]{iconAbortTypesetting}}. -By clicking on that button or by hitting \keysequence{Ctrl+T} (Mac OS X: \keysequence{Cmd+T}) again, the {\LaTeX} process is terminated. The output panel is still visible and so one can still see the error message. -\end{itemize} - -You should note that sometimes an error appears far from its actual position. For example, when opening an environment but not closing it, {\LaTeX} doesn't see the error before it encounters another end of environment without closing of the first one. The error is often only picked up at the \verb|\end{document}| command, which shows that another environment was not closed! - -Sometimes, an error still occurs during subsequent runs of {\AllTeX} even after it was corrected in the document. This can happen because {\AllTeX} creates a number of intermediary files which can still contain the original, erroneous code. Therefore, it is advisable to remove those files after fixing an error. {\Tw} provides a command to facilitate this---see section \ref{sec:remove-aux-files}. - -After an error occurred, the output panel remains open---even after consecutive typesetting runs---to help you fix the problem (which can sometimes take several attempts and restarts of {\AllTeX}). Once all problems are solved, you can close the panel by the \menu{Windows}\submenu\menu{Hide Output Panel}\index{output panel!hide} menu item. As an alternative, you can also configure to output panel to hide automatically as soon as the typesetting process finishes successfully by setting \menu{Edit}\submenu\menu{Preferences\dots}\submenu\menu{Typesetting}\submenu\menu{Hide output panel} to \emph{On success}. Since one can easily overlook other problems in the document (e.g., undefined references) that do not cause {\AllTeX} to fail, this option is only recommended to expert users. - -To help you in finding and fixing error (at least if you are using {\LaTeX}), {\Tw} comes with a small script that extracts all errors, warnings, and other noteworthy messages from the console output and presents them to you in a simple, tabular form. - -\begin{center}\label{fig:errorParsingScript} -\includegraphics{errorParsingScript} -\end{center} - -Here, you see a list of {\LaTeX} messages, color-coded and sorted by severity. Red represents errors, yellow indicates warnings, and blue stands for over- and underfull box warnings. Next to the colour bar, you see the name of the file in which the error was detected. Next to that, you see the line number (if the script was able to determine that), as well as an excerpt from the console output telling you what the error was. Moreover, the filename is a link which will take you to the file (and, if a line number could be determined, also the line) where {\LaTeX} reported the error. Hopefully, you can quickly fix any errors that may occur this way. - -In case you are not using {\LaTeX}, this script may be of little use, particularly if the console output is formatted differently. In this case, you can simply disable the error parsing hook script (see section \ref{sec:installing-scripts}). - -\section{Changing {\Tw} parameters for convenience} -\index{TeXworks@{\Tw}!parameters} - -If the default font\index{editor!font} of the editor doesn't suit you, it is possible to change it from \menu{Format}\submenu\menu{Font\ldots} by selecting a new one in the dialogue box which appears. This change will apply only to the current window, and until {\Tw} is restarted. - -From the \menu{Typeset} menu or from the drop-down on the \menu{Typesetting tool bar}, you can change the compilation format. Again this change will only be temporary and for the current document. - -To have permanent changes, you need to change the \emph{preferences\index{preferences}} through the \menu{Edit}\submenu\menu{Preferences\ldots} menu item, using the \menu{Editor} tab for the font and the \menu{Typesetting} tab for the compilation format: the default format is at the bottom of the tab. - +% !TEX encoding = UTF8 +% !TEX root = manual.tex +% !TEX spellcheck = en_UK + +\chapter{First steps} +\label{chap:first-steps} + +Let's now see how to create a first document: for this you'll need to type some text in the editor window of {\Tw}. {\AllTeX} is \emph{not} WYSIWYG\index{WYSIWYG}\footnote{\emph{What You See Is What You Get}.} software, so you'll have to type the text and the instructions for formatting it and you'll see the result only after ``typesetting'' the text. This looks a little bit dry, but one very quickly gets used to it and it is well worth the effort. + +\section{Interface summary}\index{interface} + +\newsavebox{\inlineimg} +\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar1}\hspace{1em}} + +When one opens the editor, it shows a very sparse interface: a title bar, a menu bar, two small toolbars\index{toolbar}, a large typing zone (white) and, at the bottom, a status bar. We are in the \emph{source/editor\index{source/editor}} window. If you have already typeset the document previously, the resulting \path{.pdf} will be shown on the right hand side in the \emph{preview}\index{preview} window. +\vspace{10pt} + +\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar1}\hspace{.5em}} +%\begin{wrapfigure}[2]{l}{\widthof{\usebox{\inlineimg}}} +\begin{wrapfigure}[2]{l}{90pt} +\vspace*{-1em} +\usebox{\inlineimg} +\end{wrapfigure} +\noindent The first toolbar has a button to typeset and an drop-down menu to choose the format for typesetting (we'll choose \verb+pdfLaTeX+). Knowing that the keyboard shortcut for typesetting is \keysequence{Ctrl+T} (macOS: \keysequence{Cmd+T}) and that we almost never change the format, we could even hide this toolbar. The selection of a format for compiling can also be changed through the \menu{Typeset}\index{typeset} menu. +\vspace{10pt} + +%\includegraphics[scale=.6]{toolbar2}\hspace{10pt}% +\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar2}\hspace{.5em}} +%\begin{wrapfigure}[2]{l}{\widthof{\usebox{\inlineimg}}} +\begin{wrapfigure}[2]{l}{160pt} +\vspace*{-1em} +\usebox{\inlineimg} +\end{wrapfigure} +\noindent The second toolbar provides the standard functions: New document, Open, Save | Undo, Redo | Cut, Copy, Paste | Search, Replace. + +\begin{center} +\includegraphics[width=\textwidth]{interface-summary} +\end{center} + +Even though they are not looking like real buttons, the widgets in the status bar can be clicked. The widgets showing the current position (line or page, respectively), for example, open a dialog to enter a line or page to jump to when clicked. The other widgets typically open contextual menus where some settings can be changed. + +\section{Creating a document} + +\subsection{Writing the document} + +As an example of the use of {\Tw}, we will work with \LaTeX\index{TeX@\TeX!\LaTeX}, but any other {\TeX} system is possible. In particular, if you need to use some special fonts\footnote{You can only use fonts {\AllTeX} knows, most of which are coming in packages included in your distribution. You cannot use your ``normal'' fonts, unfortunately. For more information, see for example \url{http://faq.tug.org/} and \url{http://www.tug.dk/FontCatalogue/}.}---a mandatory font for an official template, non-Latin alphabets, etc.---the {\XeTeX} system is very powerful.\footnote{See the bibliography for pointers to {\XeTeX} and \XeLaTeX.} + +Let's create our first document\index{document!creation} now. Enter the following text exactly as shown. To show some of the features of {\Tw}/{\LaTeX}, it is in French intentionally. + +\begin{example} +\documentclass{article} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{geometry} +\geometry{a4paper} + +\usepackage[frenchb]{babel} + +\title{Premier document} +\author{Un TeXnicien} +\date{} + +\begin{document} +\maketitle + +Voici un texte accentué en français! + +\end{document} +\end{example} + +Save the file in a folder for test documents (e.g., \path{<home>\TeXworks_tests}); call the file \path{first.tex}. Note that it should have a \path{.tex} extension\index{extension .tex}. + +\subsection{Typesetting the document and viewing it} + +Next we start typesetting\index{document!typesetting}\footnote{We also use the words ``compilation'' and ``to compile'' for the same action; indeed {\LaTeX} works on the source file to produce a \path{.pdf} output, so there is a compilation.} by clicking the green button \raisebox{-2pt}{\includegraphics{iconTypeset}} +or by \keysequence{Ctrl+T}\index{Ctrl+T|texttt} (macOS: \keysequence{Cmd+T}). + +A new panel opens between the typing area and the status bar: the \emph{output panel\index{output panel}}, labeled \emph{Log\index{log}}; everything {\LaTeX} is doing is displayed there\footnote{see page \pageref{fig:consoleOutput} for a picture of the panel}. When {\LaTeX} finishes this panel disappears (if there no error occurred) and a new window will appear; in this new window, the \emph{Preview window\index{preview window}}\index{document!previewing}, you can see a page with a title \foreignlanguage{french}{``Premier document''} followed by the name of the author \foreignlanguage{french}{``Un TeXnicien''}, both centred, the text +\foreignlanguage{french}{``Voici un texte accentué en français!''}, and a page number at the bottom centre. + +Notice that the mouse cursor is like a magnifier in the new window. If you press (and hold) the left button of the mouse you can see the text under the magnifier much bigger (it is a magnifier, isn't it!); you can move the magnifier and so inspect the text in detail. + +To go back to the source, you can just click in its window or better use \keysequence{Ctrl+'}\index{Ctrl+'|texttt} (macOS \keysequence{Cmd+'}). This shortcut toggles between the two windows. See also section \ref{sec.synctex} to automatically move to a specific location in the output from the source or vice versa. + +\subsection{The work of \LaTeX} + +Let's shortly analyse the result to understand what \LaTeX{} did and why, now. Introductions and full tutorials can be found on the internet: see for example \emph{lshort}\footnote{\emph{The (Not So) Short Introduction to \LaTeXe}} which should be installed as part of your {\TeX} distribution, and is also available from CTAN\index{CTAN}.\footnote{\emph{Comprehensive TeX Archives Network}, a network of mirror servers of the central CTAN; there, one can find almost everything about {\TeX}, {\LaTeX}, and more: \url{http://www.ctan.org}} + +First, we ask to create a document of the \emph{article} class: this defines the global layout of the document. + +Next, we say that the input document (the source) is saved with the Unicode encoding \emph{utf-8\index{encoding!utf-8}\index{utf-8|see{encoding, utf-8}}} and that it may contain characters which are not present in the standard ASCII without accents. We also want to use an output encoding T1 (the modern {\TeX} encoding); we also want an \emph{A4} document and not the default \emph{US letter} size. Finally, we make it clear that the typography should follow the French rules using the \textbf{\textsf{babel}} package.\footnote{This influences, e.g., automatic hyphenation of words or the way punctuation characters are typeset} Those general instructions for the work are done by packages\index{packages} called with options. + +Lastly, we finish the declaration part of the document, the \emph{preamble}\index{preamble}, giving the title, the author, and the date of the document; here we specify no date. + +Next comes the body of the document, which describes the actual content, between the lines \verb+\begin{document}+ and \verb+\end{document}+ (these are {\LaTeX} commands). + +Let's do some experiments to show the effect of these instructions. For this, we put a \% in front of the instructions; the \% and everything after it will be considered as comment\index{comments}, which will be ignored by {\LaTeX}.\footnote{Notice that the comments are, by default (this can be changed), coloured red by {\Tw}, so we see them well.} + +Comment out the line \verb|\usepackage[utf8]{inputenc}|, and typeset the file. You should see that the accented characters are now displayed incorrectly in the preview window. If, in addition, you also comment out the line \verb|\usepackage[frenchb]{babel}|, {\LaTeX} will give an error. Just hit \Return to continue the typesetting. + +%Comment out the line \verb|\usepackage[utf8]{inputenc}|, and typeset the file. You should see that the accented characters are now incorrect in the preview window. If you now comment out the line \verb|\usepackage[french]{babel}|, {\LaTeX} will give an error. Just hit \Return to continue the typesetting. + +\needspace{3\baselineskip} +After these experiments, let's modify the text as follows: +\begin{example} +\begin{document} +\maketitle +\tableofcontents + +\section{Petite démonstration} + +Voici un texte accentué en français! +Suite du texte entré après avoir fait un retour chariot. Dans +l'éditeur on peut demander un passage automatique à la ligne +du texte saisi; mais le numéro de ligne n'est incrémenté que par un +retour chariot. + +Nouvelle ligne en passant une ligne dans la source: c'est la +manière d'indiquer un changement de paragraphe. + +\end{document} +\end{example} +Redo the previous experiments and observe the changes which appear. + +Note that entering only one carriage return doesn't create a new paragraph. In {\LaTeX}, one has to have an empty line for that. In {\Tw}, the line number of the source (on the right in the status bar) numbers the lines created with carriage return, not the wrapped lines. + +\section{And when errors occur?}\index{errors} + +When you create a document for typesetting with {\LaTeX}, you cannot avoid making mistakes: forgetting a closing brace or an \verb|\end{}| to close an environment, using mathematical commands without switching to mathematical mode, etc. When you compile and there is an error, {\LaTeX} stops, giving you a chance to deal with the problem. This is shown by the stopping of the scrolling action in the output panel, and an error message being displayed, with {\LaTeX} waiting for an instruction to know what it should do. + +\begin{center}\label{fig:consoleOutput} +\includegraphics{consoleOutput} +\end{center} + +One sees the \emph{typing cursor\index{typing cursor}} in the line between the output panel and the status bar: the \emph{console bar\index{console bar}}. + +The error message is on many lines, for example like this: +\smallskip + +\begin{verbExample} +! Undefined control sequence. +l.168 ... fermante ou d'une commande \veb + +\end{}+ de fermeture d'un... +? +\end{verbExample} + +{\LaTeX} says that it doesn't recognize the command name, sometimes suggests to see the manual or to type \verb|h| (plus \Return) for help, points to the line number where it noticed the error\footnote{Unfortunately, this does not always have to be the place where the actual mistake was made in the sources. This is discussed later.} (here 168), and shows the place of the error at the cut of the line (here at \verb|\veb|). Finally, it shows that it waits for an action from us by displaying a single question mark. + +There are different possible actions: +\begin{itemize} +\item Type \Return and ask to continue as if nothing happened; sometimes this allows to finish compiling, but there will be an error in the result. +\item Type \verb+h+\Return to ask for help; this help is not always clearer than the error message, but often gives a clue. +\item Type \verb+i+\Return to tell {\LaTeX} that we will propose a replacement text. Enter the text followed by \Return; it will be used, beginning at the start of the error, but you should correct the source afterwards as {\LaTeX} never changes that. +\item Type \verb+x+\Return to stop compilation. This is the traditional {\AllTeX} way to kill a typesetting process. + +We can also kill the typesetting by repeating the action used to start it: the green typesetting button will have changed to a red one with a white cross \raisebox{-2pt}{\includegraphics[scale=.8]{iconAbortTypesetting}}. +By clicking on that button or by hitting \keysequence{Ctrl+T} (macOS: \keysequence{Cmd+T}) again, the {\LaTeX} process is terminated. The output panel is still visible and so one can still see the error message. +\end{itemize} + +You should note that sometimes an error appears far from its actual position. For example, when opening an environment but not closing it, {\LaTeX} doesn't see the error before it encounters another end of environment without closing of the first one. The error is often only picked up at the \verb|\end{document}| command, which shows that another environment was not closed! + +Sometimes, an error still occurs during subsequent runs of {\AllTeX} even after it was corrected in the document. This can happen because {\AllTeX} creates a number of intermediary files which can still contain the original, erroneous code. Therefore, it is advisable to remove those files after fixing an error. {\Tw} provides a command to facilitate this---see section \ref{sec:remove-aux-files}. + +After an error occurred, the output panel remains open---even after consecutive typesetting runs---to help you fix the problem (which can sometimes take several attempts and restarts of {\AllTeX}). Once all problems are solved, you can close the panel by the \menu{Windows}\submenu\menu{Hide Output Panel}\index{output panel!hide} menu item. As an alternative, you can also configure to output panel to hide automatically as soon as the typesetting process finishes successfully by setting \menu{Edit}\submenu\menu{Preferences\dots}\submenu\menu{Typesetting}\submenu\menu{Hide output panel} to \emph{On success}. Since one can easily overlook other problems in the document (e.g., undefined references) that do not cause {\AllTeX} to fail, this option is only recommended to expert users. + +To help you in finding and fixing error (at least if you are using {\LaTeX}), {\Tw} comes with a small script that extracts all errors, warnings, and other noteworthy messages from the console output and presents them to you in a simple, tabular form. + +\begin{center}\label{fig:errorParsingScript} +\includegraphics{errorParsingScript} +\end{center} + +Here, you see a list of {\LaTeX} messages, color-coded and sorted by severity. Red represents errors, yellow indicates warnings, and blue stands for over- and underfull box warnings. Next to the colour bar, you see the name of the file in which the error was detected. Next to that, you see the line number (if the script was able to determine that), as well as an excerpt from the console output telling you what the error was. Moreover, the filename is a link which will take you to the file (and, if a line number could be determined, also the line) where {\LaTeX} reported the error. Hopefully, you can quickly fix any errors that may occur this way. + +In case you are not using {\LaTeX}, this script may be of little use, particularly if the console output is formatted differently. In this case, you can simply disable the error parsing hook script (see section \ref{sec:installing-scripts}). + +\section{Changing {\Tw} parameters for convenience} +\index{TeXworks@{\Tw}!parameters} + +If the default font\index{editor!font} of the editor doesn't suit you, it is possible to change it from \menu{Format}\submenu\menu{Font\ldots} by selecting a new one in the dialogue box which appears. This change will apply only to the current window, and until {\Tw} is restarted. + +From the \menu{Typeset} menu or from the drop-down on the \menu{Typesetting tool bar}, you can change the compilation format. Again this change will only be temporary and for the current document. + +To have permanent changes, you need to change the \emph{preferences\index{preferences}} through the \menu{Edit}\submenu\menu{Preferences\ldots} menu item, using the \menu{Editor} tab for the font and the \menu{Typesetting} tab for the compilation format: the default format is at the bottom of the tab. + diff -Nru texworks-manual-20200329/src/en/frontmatter.tex texworks-manual-20210308/src/en/frontmatter.tex --- texworks-manual-20200329/src/en/frontmatter.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/frontmatter.tex 2021-03-08 17:33:22.000000000 +0100 @@ -8,7 +8,7 @@ \setcounter{page}{0} \DocumentCopyright{\footnotesize -Copyright {\copyright} 2010--2019 Alain Delmotte, Stefan Löffler, and contributors. Some rights reserved. +Copyright {\copyright} 2010--2021 Alain Delmotte, Stefan Löffler, and contributors. Some rights reserved. This manual is free documentation: you can redistribute it and/or modify it under the terms of either diff -Nru texworks-manual-20200329/src/en/html/Makefile texworks-manual-20210308/src/en/html/Makefile --- texworks-manual-20200329/src/en/html/Makefile 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/html/Makefile 2021-03-08 17:33:22.000000000 +0100 @@ -57,7 +57,7 @@ @echo "Creating image $@ (from $<)" @mkdir -p images # Some versions of convert refuse to produce .eps files due to security concerns - @convert "$<" "$@" $(SUPRESSOUT) 2$(SUPRESSOUT) || convert "$<" ppm: | pnmtops -noturn | eps2eps - "$@" + @convert "$<" "$@" $(SUPRESSOUT) 2$(SUPRESSOUT) || convert "$<" ppm:- | pnmtops -noturn | eps2eps - "$@" index.ind : images $(SOURCES) manual.cfg tex4ht.env diff -Nru texworks-manual-20200329/src/en/installation.tex texworks-manual-20210308/src/en/installation.tex --- texworks-manual-20200329/src/en/installation.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/installation.tex 2021-03-08 17:33:22.000000000 +0100 @@ -1,65 +1,65 @@ -% !TEX encoding = UTF8 -% !TEX root = manual.tex -% !TEX spellcheck = en_US - -\chapter{Installation} -\index{installation} -\label{chap.installation} - -\Tw{} is only a text editor; to be able to create documents with \AllTeX{} and to typeset them to PDF, we also need what is called a \emph{{\TeX} distribution}\index{TeX distribution@{\TeX} distribution}\index{TeX@\TeX!distribution|see {{\TeX} distribution}}. This is a collection of programs and other files which will be automatically called by {\Tw} during its work. Thus, you need to install a distribution: we will do that \emph{before} starting {\Tw} for the first time, as this way, {\Tw} will automatically find what it needs. - -\textbf{TeX~Live}\index{TeX distribution@{\TeX} distribution!TeX~Live} (\url{http://www.tug.org/texlive/}), a combination of teTeX, MacTeX and XEmTeX, is available for all three operating systems (Linux, Mac OS X, Windows). Note that you need a reasonably recent version of TeX~Live (2012 or later at the time of writing) to use all features of {\Tw}. - -\begin{OSLinux} -For Linux\index{TeX distribution@{\TeX} distribution!Linux}: most Linux distributions include a {\TeX} distribution, but it may not be installed by default and you will have to use the Linux package management tools to do that. Alternatively, you can also download and install TeX~Live directly from \url{http://www.tug.org/texlive/}. -\end{OSLinux} - -\begin{OSMac} -For the Mac\index{TeX distribution@{\TeX} distribution!Mac}: \textbf{MacTeX}\index{TeX distribution@{\TeX} distribution!Mac!MacTeX}, a new distribution based on gwTeX and XeTeX, is available; see \url{http://www.tug.org/mactex/}. -\end{OSMac} - -\begin{OSWindows} -For Windows\index{TeX distribution@{\TeX} distribution!Windows}: a very popular distribution is \textbf{MiKTeX}\index{TeX distribution@{\TeX} distribution!Windows!MikTeX} (\url{http://www.miktex.org/}). MikTeX has an update programme, which has also been ported to Linux. You can also use the XEmTeX distribution (\url{http://www.xemtex.org/}). -\end{OSWindows} - -For details on portable usage, and changing local configuration locations, please see the section Portable Usage \& Changing the Configuration -- section \ref{sec.portable_configuration} (on page \pageref{sec.portable_configuration}). - -\section{Under Windows}\index{installation!Windows} - -Most of the larger {\TeX} distributions already contain {\Tw} as a package. Sometimes, these versions even have some distribution-specific enhancements. So, the preferred way of installing {\Tw} on Windows is to use the package manager of your distribution. In this case, you can skip the next few paragraphs. Be sure to read the end of this section, though, as it provides important information about customizing {\Tw} to your needs. - -If you want to obtain an ``official'' version, obtain {\Tw} by downloading the setup from the {\Tw} web site \url{http://tug.org/texworks/} after the installation of the {\TeX} distribution. - -Simply install {\Tw} by running the setup file. During the installation, you will be asked where to install the program, if you want to create shortcuts, and if you want to always open \path{.tex} files with {\Tw}. There are reasonable default values that should work well for most users. - -If you want full control over how and where {\Tw} is put, you can also download the \path{.zip} archive from the website and unpack it wherever you like. Note that in this case, shortcuts and file associations must be created manually. - -\urldef{\TwRegistryPath}\path{\HKEY_USERS\S-...\Software\TUG\TeXworks} - -When you start {\Tw} for the first time, it creates a folder named \path{TeXworks}\index{folder!TeXworks}\index{folder!resource} in your home folder\footnote{on Windows XP, your home folder is \path{C:\Documents and Settings\<your name>}. On Windows Vista/7, your home folder is \path{C:\Users\<your name>}.}. This folder will contain some sub-folders for auto-completion\index{folder!auto-completion}, configuration\index{folder!configuration}, dictionaries\index{folder!dictionaries}, templates\index{folder!templates}, and interface translation/localisation\index{folder!translations} files---we will see these in more detail later.\footnote{{\Tw} will save its preferences in the registry: -\TwRegistryPath. If this is erased, it will be recreated with default values at the next use.} - -NB. At the time of writing, if \path{<your name>} contains any non-ASCII characters (for example accented characters), some functions of {\Tw} may not work correctly. For example, the spell-checker and forward/reverse synchronization between the source and \path{.pdf} will be impaired. - -\section{Under Linux}\index{installation!Linux} - -Several common Linux distributions already have packages for {\Tw}. They are adequate for most users and facilitate installing {\Tw} considerably. - -If your Linux distribution does not provide recent, adequate packages, you need to build {\Tw} from source yourself, which is fairly easy on Linux. After the installation of the {\TeX} distribution, go to \url{https://github.com/TeXworks/texworks/wiki/Building} and follow the instructions suitable for your Linux distributions. Also see section \ref{sec.compiling}. - -Once the program is installed, start {\Tw}. The folders \path{.TeXworks}\index{folder!.TeXworks} and \path{.config/TUG}\index{folder!.config/TUG} will be created in your home directory. - -\section{Under Mac OS X}\index{installation!Mac} - -If you want to obtain an ``official'' version, obtain {\Tw} by downloading the archive from the {\Tw} web site \url{http://tug.org/texworks/} after the installation of the {\TeX} distribution. - -It comes as a standalone \texttt{.app} package that does not require any Qt files installed into \path{/Library/Frameworks}, or other libraries into \path{/usr/local/lib}. Just copy the \path{.app} anywhere you like and run it. - -On Mac OS X, the {\Tw} resource\index{folder!resource Mac} folder will be created in your \path{Library} folder (\path{~/Library/TeXworks/}), inside your home directory. Preferences are stored in \path{~/Library/Preferences/org.tug.TeXworks.plist} -which you can delete if you ever suspect it is causing problems. - -\section{Ready!} - -Finally, some files may need to be added to the ``personal'' files that {\Tw} creates. As the exact location of these depends on your platform, this will be referred to as \path{<resources>}\index{folder!$\langle$resources$\rangle$} or the \textbf{{\Tw} resource folder} throughout this manual. On Linux, this is \path{~/.TeXworks}, on Windows~XP it is \path{C:\Documents and Settings\<your name>\TeXworks}, on Windows Vista/7 it is \path{C:\Users\<your name>\TeXworks}, and on Mac OS X it is \path{~/Library/TeXworks/} by default. The easiest way to locate this folder in recent versions of {\Tw} is to use the \menu{Help}\submenu\menu{Settings and Resources\dots} menu item. It opens a dialog which shows you where {\Tw} saves its settings and where it looks for resources. - -After installation and first run, have a look in the sub-folders of the {\Tw} resource folder and delete any \path{qt_temp.xxxx} files; they are temporary files left behind and could interfere with the normal ones, which are installed in the same folder, later on. +% !TEX encoding = UTF8 +% !TEX root = manual.tex +% !TEX spellcheck = en_US + +\chapter{Installation} +\index{installation} +\label{chap.installation} + +\Tw{} is only a text editor; to be able to create documents with \AllTeX{} and to typeset them to PDF, we also need what is called a \emph{{\TeX} distribution}\index{TeX distribution@{\TeX} distribution}\index{TeX@\TeX!distribution|see {{\TeX} distribution}}. This is a collection of programs and other files which will be automatically called by {\Tw} during its work. Thus, you need to install a distribution: we will do that \emph{before} starting {\Tw} for the first time, as this way, {\Tw} will automatically find what it needs. + +\textbf{TeX~Live}\index{TeX distribution@{\TeX} distribution!TeX~Live} (\url{http://www.tug.org/texlive/}), a combination of teTeX, MacTeX and XEmTeX, is available for all three operating systems (Linux, macOS, Windows). + +\begin{OSLinux} +For Linux\index{TeX distribution@{\TeX} distribution!Linux}: most Linux distributions include a {\TeX} distribution, but it may not be installed by default and you will have to use the Linux package management tools to do that. Alternatively, you can also download and install TeX~Live directly from \url{http://www.tug.org/texlive/}. +\end{OSLinux} + +\begin{OSMac} +For the Mac\index{TeX distribution@{\TeX} distribution!Mac}: \textbf{MacTeX}\index{TeX distribution@{\TeX} distribution!Mac!MacTeX}, a distribution based on gwTeX and XeTeX, is available; see \url{http://www.tug.org/mactex/}. +\end{OSMac} + +\begin{OSWindows} +For Windows\index{TeX distribution@{\TeX} distribution!Windows}: a very popular distribution is \textbf{MiKTeX}\index{TeX distribution@{\TeX} distribution!Windows!MikTeX} (\url{http://www.miktex.org/}). MikTeX has an update programme, which has also been ported to Linux. +\end{OSWindows} + +For details on portable usage, and changing local configuration locations, please see the section Portable Usage \& Changing the Configuration -- section \ref{sec.portable_configuration} (on page \pageref{sec.portable_configuration}). + +\section{Under Windows}\index{installation!Windows} + +Most of the larger {\TeX} distributions already contain {\Tw} as a package. Sometimes, these versions even have some distribution-specific enhancements. So, the preferred way of installing {\Tw} on Windows is to use the package manager of your distribution. In this case, you can skip the next few paragraphs. Be sure to read the end of this section, though, as it provides important information about customizing {\Tw} to your needs. + +If you want to obtain an ``official'' version, obtain {\Tw} by downloading the setup from the {\Tw} web site \url{http://tug.org/texworks/} after the installation of the {\TeX} distribution. + +Simply install {\Tw} by running the setup file. During the installation, you will be asked where to install the program, if you want to create shortcuts, and if you want to always open \path{.tex} files with {\Tw}. There are reasonable default values that should work well for most users. + +If you want full control over how and where {\Tw} is put, you can also download the \path{.zip} archive from the website and unpack it wherever you like. Note that in this case, shortcuts and file associations must be created manually. + +\urldef{\TwRegistryPath}\path{\HKEY_CURRENT_USER\Software\TUG\TeXworks} + +When you start {\Tw} for the first time, it creates a folder named \path{C:\Users\<your name>\AppData\Roaming\TUG\TeXworks}\index{folder!resource}. This folder will contain some sub-folders for auto-completion\index{folder!auto-completion}, configuration\index{folder!configuration}, dictionaries\index{folder!dictionaries}, templates\index{folder!templates}, and interface translation/localisation\index{folder!translations} files---we will see these in more detail later.\footnote{{\Tw} will save its preferences in the registry: +\TwRegistryPath. If this is erased, it will be recreated with default values at the next use.} + +NB: At the time of writing, if \path{<your name>} contains any non-ASCII characters (for example accented characters), some functions of {\Tw} may not work correctly. For example, the spell-checker and forward/reverse synchronization between the source and \path{.pdf} will be impaired. + +\section{Under Linux}\index{installation!Linux} + +Several common Linux distributions already have packages for {\Tw}. They are adequate for most users and facilitate installing {\Tw} considerably. + +If your Linux distribution does not provide recent, adequate packages, you need to build {\Tw} from source yourself, which is fairly easy on Linux. After the installation of the {\TeX} distribution, go to \url{https://github.com/TeXworks/texworks/wiki/Building} and follow the instructions suitable for your Linux distributions. Also see section \ref{sec.compiling}. + +Once the program is installed, start {\Tw}. The folders \path{.local/share/TUG/TeXworks}\index{folder!resource} and \path{.config/TUG} will be created in your home directory. + +\section{Under macOS}\index{installation!Mac} + +If you want to obtain an ``official'' version, obtain {\Tw} by downloading the archive from the {\Tw} web site \url{http://tug.org/texworks/} after the installation of the {\TeX} distribution. + +It comes as a standalone \texttt{.app} package that does not require any Qt files installed into \path{/Library/Frameworks}, or other libraries into \path{/usr/local/lib}. Just copy the \path{.app} anywhere you like and run it. + +On macOS, the {\Tw} resource\index{folder!resource} folder will be created in your \path{Library} folder (\path{~/Library/Application Support/TUG/TeXworks}), inside your home directory. Preferences are stored in \path{~/Library/Preferences/org.tug.TeXworks.plist} +which you can delete if you ever suspect it is causing problems. + +\section{Ready!} + +Finally, some files may need to be added to the ``personal'' files that {\Tw} creates. As the exact location of these depends on your platform, this will be referred to as \path{<resources>}\index{folder!resource} or the \textbf{{\Tw} resource folder} throughout this manual. On Windows, this is \path{C:\Users\<your name>\AppData\Roaming\TUG\TeXworks}, on Linux it is \path{.local/share/TUG/TeXworks}, and on macOS it is \path{~/Library/Application Support/TUG/TeXworks} by default. The easiest way to locate this folder in recent versions of {\Tw} is to use the \menu{Help}\submenu\menu{Settings and Resources\dots} menu item. It opens a dialog which shows you where {\Tw} saves its settings and where it looks for resources. + +After installation and first run, have a look in the sub-folders of the {\Tw} resource folder and delete any \path{qt_temp.xxxx} files; they are temporary files left behind and could interfere with the normal ones, which are installed in the same folder, later on. \ No newline at end of file diff -Nru texworks-manual-20200329/src/en/introduction.tex texworks-manual-20210308/src/en/introduction.tex --- texworks-manual-20200329/src/en/introduction.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/introduction.tex 2021-03-08 17:33:22.000000000 +0100 @@ -1,72 +1,72 @@ -% !TEX encoding = UTF8 -% !TEX root = manual.tex -% !TEX spellcheck = en_US - -\chapter{Introduction} - -Donald E. Knuth\index{Knuth, Donald E.} decided to create a new typesetting system, which would be called {\TeX}\index{TeX@\TeX}, because there had been a change in the printing system used for the volumes of his book \emph{The Art of Computer Programming} and Knuth found the result of the new system awful. - -The goal of {\TeX} was then to have a system which would always produce the same documents independently of the actual machine they were processed on. Knuth also designed the \emph{Computer Modern} family of typefaces and the \METAFONT\index{METAFONT|textsf} language for font description. - -The work initiated in 1977 was finished (the languages were ``frozen'') in 1989. {\TeX} and {\METAFONT} are not evolving any more except for minor bug fixes ({\TeX} versions are numbered following the decimals of $\pi$---now 3.1415926---and {\METAFONT} the decimals of the number ``e''---now 2.718281). - -{\TeX} provides basic tools (commands/instructions/``primitives'') to define typesetting; almost every detail has to be defined, but the language allows the creation of macros for repeatedly used constructs. So collections of macros are loaded through format files\index{files!format} (i.e., pre-compiled large macro collections). - -Knuth created an original default format (600 commands, more or less) which is called \emph{Plain \TeX\index{TeX@\TeX!Plain}}. This facilitates creating documents. - -The most widely used format is \LaTeX\index{TeX@\TeX!\LaTeX} (Leslie Lamport\index{Lamport, Leslie}, 1985), which provides more global commands and structures for documents (article, book,\dots) allowing easier and faster work, but sometimes with loss of flexibility due to the more or less rigid framework. But there are many other formats and {\TeX}-variants in use as well, such as \AmS-\TeX\index{TeX@\TeX!\AmS-\TeX}, \AmS-\LaTeX, \ConTeXt\index{TeX@\TeX!\ConTeXt}, or \XeTeX, each having specific goals and advantages (and drawbacks). - -To extend the format, one loads ``packages\index{packages}'' which are collections of macros specific to some aspect of typesetting. - -From its specification in the late 1970s, the {\TeX} family had to evolve until now, last version March 2008, to take into account the developments in the typesetting world outside {\TeX}. - -Some of the problems to answer were/are: -\begin{itemize} - \item taking into account other languages with ``alphabets'' larger than the ASCII\footnote{``American Standard Code for Information Interchange'': a character encoding scheme including only Latin characters found in English, some common punctuation characters, and a few other symbols such as \% or \$} one or with non-Latin characters altogether, - \item having more fonts, there is not much variety in the fonts created with {\METAFONT} (few font creators use it), - \item creating documents in other formats than the normal DVI\footnote{``Device Independent'': format of files produced by {\TeX}}, - \item using the rich possibilities of other typesetting systems and formats like PostScript and PDF, - \item having more calculation and scripting facilities,\dots -\end{itemize} - -To answer these questions and others, many ``engines'' and programmes have been created around {\TeX}, including pdftex\index{TeX@\TeX!pdftex}, pdflatex, dvips\index{TeX@\TeX!dvips}, ps2pdf, and {\METAPOST}\index{METAPOST|textsf}, which opens the {\TeX} world to the possibilities of PostScript\index{PostScript} and PDF\index{PDF}. \XeTeX\index{TeX@\TeX!XeTeX} and \XeLaTeX to be able to use the ``normal'' fonts found on the different machines and to be able to cope with writing systems different from the left to right systems which originated in Europe (Latin and Cyrillic letters and associates)---right to left, vertically, pictograms,\dots Or LuaTeX\index{TeX@\TeX!LuaTeX} and LuaLaTeX to have a powerful scripting language. - -To use {\TeX} and the systems of its family, one has to create a ``source'' document\index{document!source} as {\TeX} is only a system to ``transform'' a source document into a (beautifully) typeset document. This source is a simple text with typesetting instructions and one needs a programme to create it: the editor\index{editor}. - -There are many editors able to create a {\TeX} source; some are general editors, others are specifically designed for {\TeX}: here \Tw\index{TeXworks@{\Tw}} comes in. -\bigskip - -\textbf{\Tw} is a project to create a text editor for use with the {\TeX} family of tools; we will refer to these as \AllTeX. Instead of creating a new sophisticated program, equipped with multiple tool-bars to meet any need, {\Tw} provides a simple editor, offering at first sight only a limited set of tools for text editing as well as a single button and a menu to typeset a {\AllTeX} text. - -The idea to create the editor came to \emph{Jonathan Kew\index{Kew, Jonathan}}, the initiator and leader of the project, after a long period of reflection on the reasons why potential users tend to keep away from \AllTeX, as well as pondering the success of the \textbf{{\TeX}Shop\index{TeXShop@{\TeX}Shop}} editor on the Mac. - -Finally the goal was also to provide the same editor on many operating systems: {\Tw} currently runs on Linux, Mac OS X and Windows. The interface is always the same and the program offers the same functionality on all three platforms. - -After this introduction, the second section of this manual explains how to install the software. In the third section, we describe the interface and create a first document as well as show the basics of {\Tw}. In the forth and fifth section, the advanced tools provided by {\Tw} are presented; you should read these sections only after mastering the basic working of {\Tw}. These advanced tools allow much more effective working practices. The sixth section gives a brief introduction to scripting. This section focuses on using ready-made scripts, not on writing your own scripts (which is beyond the scope of this manual and will be presented elsewhere). After that, the seventh section in which some pointers to further information about {\Tw} and sources for help are compiled concludes the main part. - -Finally, the appendices provide additional information how {\Tw} can be customized, about the regular expression search/replace system, and how {\Tw} can be compiled from source. A short bibliography and an index conclude this manual. - -\section{Icons and style} - -Because a picture is often worth a thousand words, icons and special styling is used throughout this manual to avoid cumbersome paraphrases or mark specialties. Keyboard keys are usually depicted as \keystroke{A}, with the exception of a few special keys. These are: -\keysequence{Shift}, \keysequence{PgUp}, \keysequence{PgDown}, \keysequence{Return} (return), \keysequence{UArrow}, \keysequence{DArrow}, \keysequence{LArrow}, \keysequence{RArrow}, \keysequence{Spacebar} (space), \keysequence{BSpace} (backspace), and \keysequence{Tab} (tab). - -In addition, mouse clicks are depicted as {\LMB} (left click) and {\RMB} (right click; on Mac OS X with a one-button mouse, this is usually available by holding down {\Ctrl} while clicking). - -Apart from input instructions, several passages throughout this manual are marked by special styling. - -\needspace{5\baselineskip} -Information that is only valid or relevant for a particular operating system is marked like this: -\begin{OSWindows} -\noindent This only concerns you if you use Windows. \\ -Of course you can also read it if you use another operating system. \\ -It just will not be of much use to you. -\end{OSWindows} - -\bigskip -Code examples are set in a fixed-space, typewriter font, with lines above and below to set it apart from the rest of the text: -\begin{verbExample} -Hello \TeX-World! -\end{verbExample} - +% !TEX encoding = UTF8 +% !TEX root = manual.tex +% !TEX spellcheck = en_US + +\chapter{Introduction} + +Donald E. Knuth\index{Knuth, Donald E.} decided to create a new typesetting system, which would be called {\TeX}\index{TeX@\TeX}, because there had been a change in the printing system used for the volumes of his book \emph{The Art of Computer Programming} and Knuth found the result of the new system awful. + +The goal of {\TeX} was then to have a system which would always produce the same documents independently of the actual machine they were processed on. Knuth also designed the \emph{Computer Modern} family of typefaces and the \METAFONT\index{METAFONT|textsf} language for font description. + +The work initiated in 1977 was finished (the languages were ``frozen'') in 1989. {\TeX} and {\METAFONT} are not evolving any more except for minor bug fixes ({\TeX} versions are numbered following the decimals of $\pi$---now 3.1415926---and {\METAFONT} the decimals of the number ``e''---now 2.718281). + +{\TeX} provides basic tools (commands/instructions/``primitives'') to define typesetting; almost every detail has to be defined, but the language allows the creation of macros for repeatedly used constructs. So collections of macros are loaded through format files\index{files!format} (i.e., pre-compiled large macro collections). + +Knuth created an original default format (600 commands, more or less) which is called \emph{Plain \TeX\index{TeX@\TeX!Plain}}. This facilitates creating documents. + +The most widely used format is \LaTeX\index{TeX@\TeX!\LaTeX} (Leslie Lamport\index{Lamport, Leslie}, 1985), which provides more global commands and structures for documents (article, book,\dots) allowing easier and faster work, but sometimes with loss of flexibility due to the more or less rigid framework. But there are many other formats and {\TeX}-variants in use as well, such as \AmS-\TeX\index{TeX@\TeX!\AmS-\TeX}, \AmS-\LaTeX, \ConTeXt\index{TeX@\TeX!\ConTeXt}, or \XeTeX, each having specific goals and advantages (and drawbacks). + +To extend the format, one loads ``packages\index{packages}'' which are collections of macros specific to some aspect of typesetting. + +From its specification in the late 1970s, the {\TeX} family had to evolve until now, last version March 2008, to take into account the developments in the typesetting world outside {\TeX}. + +Some of the problems to answer were/are: +\begin{itemize} + \item taking into account other languages with ``alphabets'' larger than the ASCII\footnote{``American Standard Code for Information Interchange'': a character encoding scheme including only Latin characters found in English, some common punctuation characters, and a few other symbols such as \% or \$} one or with non-Latin characters altogether, + \item having more fonts, there is not much variety in the fonts created with {\METAFONT} (few font creators use it), + \item creating documents in other formats than the normal DVI\footnote{``Device Independent'': format of files produced by {\TeX}}, + \item using the rich possibilities of other typesetting systems and formats like PostScript and PDF, + \item having more calculation and scripting facilities,\dots +\end{itemize} + +To answer these questions and others, many ``engines'' and programmes have been created around {\TeX}, including pdftex\index{TeX@\TeX!pdftex}, pdflatex, dvips\index{TeX@\TeX!dvips}, ps2pdf, and {\METAPOST}\index{METAPOST|textsf}, which opens the {\TeX} world to the possibilities of PostScript\index{PostScript} and PDF\index{PDF}. \XeTeX\index{TeX@\TeX!XeTeX} and \XeLaTeX to be able to use the ``normal'' fonts found on the different machines and to be able to cope with writing systems different from the left to right systems which originated in Europe (Latin and Cyrillic letters and associates)---right to left, vertically, pictograms,\dots Or LuaTeX\index{TeX@\TeX!LuaTeX} and LuaLaTeX to have a powerful scripting language. + +To use {\TeX} and the systems of its family, one has to create a ``source'' document\index{document!source} as {\TeX} is only a system to ``transform'' a source document into a (beautifully) typeset document. This source is a simple text with typesetting instructions and one needs a programme to create it: the editor\index{editor}. + +There are many editors able to create a {\TeX} source; some are general editors, others are specifically designed for {\TeX}: here \Tw\index{TeXworks@{\Tw}} comes in. +\bigskip + +\textbf{\Tw} is a project to create a text editor for use with the {\TeX} family of tools; we will refer to these as \AllTeX. Instead of creating a new sophisticated program, equipped with multiple tool-bars to meet any need, {\Tw} provides a simple editor, offering at first sight only a limited set of tools for text editing as well as a single button and a menu to typeset a {\AllTeX} text. + +The idea to create the editor came to \emph{Jonathan Kew\index{Kew, Jonathan}}, the initiator and leader of the project, after a long period of reflection on the reasons why potential users tend to keep away from \AllTeX, as well as pondering the success of the \textbf{{\TeX}Shop\index{TeXShop@{\TeX}Shop}} editor on the Mac. + +Finally the goal was also to provide the same editor on many operating systems: {\Tw} currently runs on Linux, macOS and Windows. The interface is always the same and the program offers the same functionality on all three platforms. + +After this introduction, the second section of this manual explains how to install the software. In the third section, we describe the interface and create a first document as well as show the basics of {\Tw}. In the forth and fifth section, the advanced tools provided by {\Tw} are presented; you should read these sections only after mastering the basic working of {\Tw}. These advanced tools allow much more effective working practices. The sixth section gives a brief introduction to scripting. This section focuses on using ready-made scripts, not on writing your own scripts (which is beyond the scope of this manual and will be presented elsewhere). After that, the seventh section in which some pointers to further information about {\Tw} and sources for help are compiled concludes the main part. + +Finally, the appendices provide additional information how {\Tw} can be customized, about the regular expression search/replace system, and how {\Tw} can be compiled from source. A short bibliography and an index conclude this manual. + +\section{Icons and style} + +Because a picture is often worth a thousand words, icons and special styling is used throughout this manual to avoid cumbersome paraphrases or mark specialties. Keyboard keys are usually depicted as \keystroke{A}, with the exception of a few special keys. These are: +\keysequence{Shift}, \keysequence{PgUp}, \keysequence{PgDown}, \keysequence{Return} (return), \keysequence{UArrow}, \keysequence{DArrow}, \keysequence{LArrow}, \keysequence{RArrow}, \keysequence{Spacebar} (space), \keysequence{BSpace} (backspace), and \keysequence{Tab} (tab). + +In addition, mouse clicks are depicted as {\LMB} (left click) and {\RMB} (right click; on macOS with a one-button mouse, this is usually available by holding down {\Ctrl} while clicking). + +Apart from input instructions, several passages throughout this manual are marked by special styling. + +\needspace{5\baselineskip} +Information that is only valid or relevant for a particular operating system is marked like this: +\begin{OSWindows} +\noindent This only concerns you if you use Windows. \\ +Of course you can also read it if you use another operating system. \\ +It just will not be of much use to you. +\end{OSWindows} + +\bigskip +Code examples are set in a fixed-space, typewriter font, with lines above and below to set it apart from the rest of the text: +\begin{verbExample} +Hello \TeX-World! +\end{verbExample} + Closely related to this, chapter \ref{chap:first-steps} contains several tutorials, which are typeset just like the code examples above, but with an additional notebook icon next to it. \ No newline at end of file diff -Nru texworks-manual-20200329/src/en/othertools.tex texworks-manual-20210308/src/en/othertools.tex --- texworks-manual-20200329/src/en/othertools.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/othertools.tex 2021-03-08 17:33:22.000000000 +0100 @@ -7,7 +7,7 @@ \section{SyncTeX'ing between source and preview}\index{SyncTeX} \label{sec.synctex} -When you are reading a document in the preview window and see something to change, it is convenient to go immediately to the corresponding place in the source. To do so, hold down \keysequence{Ctrl} (Mac OS X: \keysequence{Cmd}) and click at the appropriate place in the preview; the cursor will move and highlight the corresponding location in the source window. The same is true in the other direction: \keysequence{Ctrl+LMB} in the source will highlight the same line in the preview window.\footnote{It is also possible to use a right-click (\keysequence{RMB}) to open a context window and select ``jump to PDF'' or ``jump to source''.} +When you are reading a document in the preview window and see something to change, it is convenient to go immediately to the corresponding place in the source. To do so, hold down \keysequence{Ctrl} (macOS: \keysequence{Cmd}) and click at the appropriate place in the preview; the cursor will move and highlight the corresponding location in the source window. The same is true in the other direction: \keysequence{Ctrl+LMB} in the source will highlight the same line in the preview window.\footnote{It is also possible to use a right-click (\keysequence{RMB}) to open a context window and select ``jump to PDF'' or ``jump to source''.} % \path doesn't support accented characters % as a workaround, use \texttt @@ -19,7 +19,7 @@ Special comments, at the very beginning of the files, can be used to manage two other aspects of the compilation. -By default, {\Tw} uses the ``utf-8'' encoding\index{encoding!utf-8} for loading and saving files, but some files could be saved in another encoding. Common ones are ``latin1''\index{encoding!latin1}, which is the dominant encoding on Windows when using western languages, and ``Apple Roman'' which is dominant on Mac OS. +By default, {\Tw} uses the ``utf-8'' encoding\index{encoding!utf-8} for loading and saving files, but some files could be saved in another encoding. Common ones are ``latin1''\index{encoding!latin1}, which is the dominant encoding on Windows when using western languages, and ``Apple Roman'' which is dominant on macOS. To set a different encoding\index{encoding} for a specific file one can put the following at the beginning of that file:\index{\verb+% "!TeX+!\verb+encoding+} \begin{verbExample} @@ -71,9 +71,9 @@ This increases legibility, but works well only on short lines, without text wrapping; or if one chooses not to use text wrapping by unchecking \menu{Format}\submenu\menu{Wrap lines}\index{wrap lines!automatic}. -The command \menu{Format}\submenu\menu{Indent} or the shortcut \keysequence{Ctrl+]} (Mac OS~X: \keysequence{Cmd+]}) will indent the line, or the selected lines, by inserting a tab character. You can repeat the process to increase the indent. +The command \menu{Format}\submenu\menu{Indent} or the shortcut \keysequence{Ctrl+]} (macOS: \keysequence{Cmd+]}) will indent the line, or the selected lines, by inserting a tab character. You can repeat the process to increase the indent. -To remove one level of indentation, use \menu{Format}\submenu\menu{Unindent} or the shortcut \keysequence{Ctrl+[} (\keysequence{Cmd+[} on Mac OS X).\footnote{See the modified shortcuts if your keyboard layout does not allow these actions.} +To remove one level of indentation, use \menu{Format}\submenu\menu{Unindent} or the shortcut \keysequence{Ctrl+[} (\keysequence{Cmd+[} on macOS).\footnote{See the modified shortcuts if your keyboard layout does not allow these actions.} As \textsl{indent} only indents the first part of very long (wrapped) lines, this is not very satisfactory in some cases. But one can ask {\Tw} to split a long line (longer than the width of the editing window) into short ones adding a hard coded line feed. \menu{Format}\submenu\menu{Hard Wrap...}\index{wrap lines!hard} opens a dialog box in which you can specify the width of the lines; you can also re-format lines which have already been split. % @@ -127,7 +127,7 @@ \verb+inipath+\index{configuration!inipath} for the configuration file and \verb+libpath+\index{configuration!libpath} for the necessary folders. Here, \path{TW_conf} would replace the resource folder \path{TeXworks}. Note that the referenced folder (here \path{TW_conf}) should exist---it will not be created---, and that the \verb|/| is used even on Windows (instead of the common \verb+\+). -If one wants to put the resource folder in the programme folder as a subfolder, one can use an instruction like \verb+inipath=./TW_conf/+; all relative paths are taken to be relative to the {\Tw} programme folder (on Mac OS X, the folder containing the app package is used). +If one wants to put the resource folder in the programme folder as a subfolder, one can use an instruction like \verb+inipath=./TW_conf/+; all relative paths are taken to be relative to the {\Tw} programme folder (on macOS, the folder containing the app package is used). One can also add a line\index{configuration!defaultbinpaths} like \begin{verbExample} diff -Nru texworks-manual-20200329/src/en/README.md texworks-manual-20210308/src/en/README.md --- texworks-manual-20200329/src/en/README.md 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/en/README.md 2021-03-08 17:33:22.000000000 +0100 @@ -43,7 +43,7 @@ Disclaimer ================================================================================ -Copyright (C) 2010-2019 Alain Delmotte, Stefan Löffler, and contributors. +Copyright (C) 2010-2021 Alain Delmotte, Stefan Löffler, and contributors. Some rights reserved. Unless noted otherwise, the icons in the images/ folder are taken from the diff -Nru texworks-manual-20200329/src/fr/autresoutils.tex texworks-manual-20210308/src/fr/autresoutils.tex --- texworks-manual-20200329/src/fr/autresoutils.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/autresoutils.tex 2021-03-08 17:33:22.000000000 +0100 @@ -1,137 +1,138 @@ -% !TEX encoding = UTF8 -% !TEX root = manuel.tex -% !TEX spellcheck = fr_FR - -\chapter{Aller plus loin: autres outils} - -\section{Passage source/vue: SyncTeX}\index{SyncTeX} -\label{sec.synctex} - -Lorsqu'on lit le document dans la fenêtre de prévisualisation et qu'on remarque quelque chose à changer, il est intéressant de passer directement au même endroit dans la source. Pour faire cela il suffit de cliquer à l'endroit souhaité de la vue en maintenant la touche \keysequence{Ctrl} enfoncée; le curseur se déplacera et mettra en surbrillance l'endroit recherché dans la source. De même inversement, si on a déjà affiché la vue et que, retourné dans la source on s'y est déplacé, \keysequence{Ctrl+LMB} mettra en surbrillance la même ligne dans la vue. \footnote{Il est aussi possible d'utiliser un clic-droit (\keysequence{RMB}) pour ouvrir le menu contextuel et choisir \og{}Aller au PDF\fg{} ou \og{}Aller à la source\fg.} - -\begin{OSWindows} -Ici une remarque pour les utilisateurs de Windows: ceci ne fonctionne que si \textbf{tous} les noms de dossier/fichiers/\dots \textbf{ne} contiennent \textbf{pas} de caractères accentués. Si, par exemple, votre document est dans \texttt{C:\textbackslash Documents and Settings\textbackslash Propriétaire\textbackslash My Documents\textbackslash these} cela ne fonctionnera pas à cause du \verb|é| de \texttt{Propriétaire}! -\end{OSWindows} - -\section{Chaînes de commande particulières} - -Des lignes de commentaires, au tout début du document, peuvent être utilisées pour régler deux autres aspects de la compilation. - -\Tw{} utilise par défaut l'encodage \og utf-8\fg\index{encodage!utf-8} quand il charge et sauvegarde les fichiers, mais certains fichiers pourraient être encodés dans un autre format. Des encodages très communs sont ``latin1''\index{encodage!latin1}, qui est l'encodage prépondérant pour les langues d'Europe de l'Ouest sous Winsows, et ``Apple Roman'' prépondérant sous Mac. - -Pour définir un autre encodage\index{encodage} pour un fichier en particulier on peut mettre en début de ce fichier:\index{\verb+% "!TeX+!\verb+encoding+} -\begin{verbExample} -% !TeX encoding = latin1 -\end{verbExample} - -Notez que sans cette linge, vous devez spécifier manuellement à \Tw{} l'encodage correct. Sinon, vos données pourraient être corrompues! Pour passer au-dessus du choix d'encodage par défaut de \Tw, utilisez le menu qui apparaît lorsque vous cliquez sur le bouton central de la barre de statut de la fenêtre d'édition. - -Si vous avez ouvert dans \Tw{} un fichier qui n'avait pas été sauvegardé en utf-8 mais auquel il manque la ligne \verb+% !TeX encodage+, il peut être affiché avec des caractères bizarres\index{caractères bizarres|see{encodage}}. Dans ce cas, vous pouvez spécifier de la même façon l'encodage correct par le bouton de la barre de statut, mais il est \emph{impératif} d'alors utiliser \menu{Recharger en utilisant l'encodage sélectionné} du même menu! Cela oblige \Tw{} de ré-ouvrir le document avec l'encodage souhaité, les caractères bizarres devraient être remplacés par des caractères normaux et c'est seulement à ce moment qu'il est sûr de continuer à travailler. Pour éviter de devoir répéter ce processus chaque fois que vous ouvrez ce fichier, vous devriez soit basculer en utf-8 pour le sauvegarder soit ajouter une ligne adéquate \verb+% !TeX encodage+. - -Si on veut compiler une fichier par un autre programme que le programme \TeX{} ou \LaTeX{} par défaut\index{programme!par défaut}, on mettra au début du fichier: -\index{\verb+% "!TeX+!\verb+program+} -\begin{verbExample} -% !TeX program = <le_programme> -\end{verbExample} -%\index{instruction \instex!programme} -par exemple: -\begin{verbExample} -% !TeX program = xelatex -\end{verbExample} - -Faites attention avec cette dernière instruction: vous devez utiliser ici le nom du programme qui doit être utilisé pour l'ensemble du projet, car c'est le nom de programme qui est le premier vu (celui du sous-document dans lequel vous êtes lorsque vous commencez la composition) qui sera utilisé. \Tw{} utilisera ce programme, même si un autre nom apparaît dans le document principal! - -Lorsqu'un document est ouvert avec une ligne \verb+% !TeX programme+, celui-ci devient le programme à utiliser et son nom apparaît dans la liste déroulante de la Barre d'outils; mais vous pouvez cependant outrepasser cela en choisissant un programme différent dans la liste déroulante, si vous le désirez. - -\needspace{3\baselineskip} -De plus, vous pouvez définir la langue de correction orthographique par une ligne de commentaire similaire: -\index{\verb+% "!TeX+!\verb+spellcheck+} -\begin{verbExample} -% !TeX spellcheck = <language_code> -\end{verbExample} -Les codes de langue disponibles sur votre système sont listés entre parenthèses dans \menu{Édition}\submenu\menu{Vérification orthographique} à côté du nom de la langue en toutes lettres. - -\needspace{6\baselineskip} -\section{Mise en forme de la source pour la lisibilité} - -Pour faciliter la lisibilité de la source, on peut utiliser l'indentation\index{edition@édition!indentation} comme le font les programmeurs: -\begin{verbExample} -\begin{itemize} - \item Premier élément de la liste; - \item deuxième élément; - \item dernier élément: - \begin{itemize} % début de sous-liste - \item premier sous-élément; - \item deuxième sous-élément. - \end{itemize} -\end{itemize} -\end{verbExample} - -Cela améliore la lisibilité, mais ne fonctionne bien que sur des lignes courtes, sans passage à la ligne automatique; ou si on demande de ne pas passer à la ligne par \menu{Format}\submenu\menu{Passage à la ligne}\index{coupure de ligne!automatique}. - -La commande \menu{Format}\submenu\menu{Indenter} ou le raccourci \keysequence{Ctrl+]} (Mac OS~X: \keysequence{Cmd+]}) vont indenter la ligne, ou les lignes sélectionnées, de quatre caractères en insérant un caractère tabulation. On peut répéter l'opération pour augmenter le retrait. - -Pour supprimer une indentation: \menu{Format}\submenu\menu{Supprimer l'indentation} ou par le raccourci \keysequence{Ctrl+[} (\keysequence{Cmd+[} sur Mac OS X). \footnote{Voir les raccourcis modifiés pour les claviers qui ne permettent pas ces actions.} - -Comme \textsl{indent} n'indente que la première ligne d'un texte multiligne (si on demande la passage à la ligne), ceci n'est pas vraiment utile. Mais on peut demander à \Tw{} de scinder une longue ligne (plus longue que la largeur du panneau d'édition) en lignes plus courtes et en y ajoutant des retours à la ligne physiques (insertion du caractère retour à la ligne): \emph{\menu{Format}\submenu\menu{Retour à la ligne physique\dots}}\index{coupure de ligne!physique} ouvre une boîte de dialogue dans laquelle vous pouvez spécifier la largeur des lignes; vous pouvez aussi re-formater des lignes qui ont déjà été scindées. -% -%\begin{center} -%\includegraphics[scale=.8]{hardwrap} -%\end{center} - -\section{Afficher les balises}\index{balises} - -Quand un document devient un peu long et qu'on veut se déplacer à un endroit précis (un chapitre, une section, une sous-section,\dots), il faut faire défiler la fenêtre d'édition pour trouver l'endroit recherché\index{balises!structure}, ou utiliser le dialogue Rechercher si vous vous souvenez d'un mot clé dans le titre du chapitre. - -Dans le même but, plus confortablement, on peut aussi afficher les balises de structure du document: l'option de menu \menu{Fenêtre}\submenu\menu{Montrer}\submenu\menu{Balise} ouvre un panneau à gauche de la zone d'édition montrant les informations détectées par \Tw. Un clic sur le niveau recherché sélectionne la partie correspondante dans la source. Ce panneau, comme tout panneau, peut être redimensionner en tirant sa bordure. - -%On peut également plus ou moins développer la structure si elle est vraiment très longue en cliquant sur le petit carré avec \og-\fg{} pour réduire/fermer une structure et sur le carré avec \og+\fg{} pour l'ouvrir. - -La même opération peut se faire dans la vue PDF par \menu{Fenêtre}\submenu\menu{Visuali\-sation}\submenu\menu{Table des matières}\index{balises!table des matières}, mais cela ne sera actif que si on a créé des balises de structure dans le fichier PDF par le module \verb|hyperref|. - -\section{Organiser les fenêtres}\index{fenêtres} - -Par défaut, la fenêtre d'édition (source) s'ouvre à gauche et la fenêtre de vue (lorsque le fichier PDF correspondant existe), à droite en partageant l'écran en deux. - -On peut changer la position des fenêtres par le menu \menu{Fenêtre}. \submenu\menu{Mosaï\-que} et \submenu\menu{Côte à côte} donnent le effet par défaut si on n'a qu'un document ouvert. Sinon \submenu\menu{Mosaïque} crée une mosaïque de toutes les fenêtres. Les autres options permettent de présenter les fenêtres selon sa convenance. On peut, évidemment, aussi toujours re-dimensionner et déplacer manuellement les fenêtres. - -Pour la vue on peut aussi changer la présentation et donc l'agrandissement\index{zoom|see{agrandissement}}\index{agrandissement} par \menu{Vue}\submenu\menu{Taille réelle}, \submenu\menu{Ajuster à la largeur} et \submenu\menu{Ajuster à la fenêtre}; on peut également effectuer des zoom positifs et négatifs. Des raccourcis clavier existent pour toutes ces actions et sont donnés à côté de l'option dans le menu. - -\section{Nettoyer le dossier de travail}\index{nettoyer le dossier} -\label{sec:remove-aux-files} - -Rapidement, lorsqu'on utilise \AllTeX, on découvre que le dossier de travail est encombré de fichiers qui ont le même nom que la source mais avec une extension différente: \path{.aux}, \path{.log}, \path{.toc}, \path{.lof}+, \path{.lot}, \path{.bbl},\dots - -Tous ces fichiers sont nécessaires à \AllTeX{} pour pouvoir créer la table des matières, les listes de figures/tableaux, la bibliographie, les références croisées et, également très important, pour avoir une trace de ce qu'il a fait (le fichier \path{.log}.) - -En dehors des fichiers externes, images, illustrations,\dots , les seuls fichiers nécessaires sont les fichiers \path{.tex}, les sources du document. On peut effacer tous les autres. Parfois cela est même nécessaire lorsque \AllTeX{} se bloque suite à une erreur. - -Ceci peut être fait par le commande \Tw{} du menu \menu{Fichier}: \submenu\menu{Supprimer les Fichiers Auxiliaires\dots}\index{nettoyer un dossier!fichiers auxiliaires}. - -Lorsque vous lancez cette commande, une boîte de dialogue s'ouvre dans laquelle vous pouvez cocher/décocher les fichiers que vous voulez enlever \footnote{Le nom du fichier principal est utilisé pour créer la liste des candidats possibles à la suppression.}. La boîte de dialogue ne ferra la liste que des fichiers actuellement dans le dossier; si vous les avez tous supprimés, vous aurez un message précisant qu'il n'y a pas de fichier à supprimer à ce moment. - -La liste des fichiers auxiliaires qui vous est proposée se trouve dans le fichier de configuration \path{texworks-config.txt}\index{configuration!texworks-config.txt} du sous-dossier \path{configuration} du dossier ressource de \Tw. Vous pourriez en ajouter si nécessaire. -%\newpage - -\section{Modifier la configuration}\index{configuration} - -Nous avons vu à la section \ref{chap.installation} (page \pageref{chap.installation}) que lors du premier lancement \Tw{} crée un dossier ressource, de même qu'il sauvegarde les informations de préférences. - -Il est cependant possible de définir soi-même l'endroit où on veut le dossier ressource et la sauvegarde des préférences. Cela peut être intéressant lorsqu'on veut un système portable (par exemple sur une clé USB) ou que l'on veut accéder facilement par exemple au dossier des modèles ou des mors clé de complétion. - -Par cela, créer dans le dossier du programme un fichier \path{texworks-setup.ini}\index{configuration!texworks-setup.ini} dans lequel on donnera la localisation des dossier contenant les sous-dossiers de complétion, configuration, dictionnaires,\dots et le fichier de configuration (\path{texworks.ini}\index{configuration!texworks.ini}); il y aura deux lignes: -\begin{verbExample} -inipath=C:/mondossier/TW_conf/ -libpath=C:/mondossier/TW_conf/\index{configuration!libpath} -\end{verbExample} - -\verb|inipath|\index{configuration!inipath} pour le fichier de configuration et \verb|libpath|\index{configuration!libpath} pour les dossiers nécessaires. Ici \path{TW\_conf} remplacerait le dossier ressource \path{TeXworks}. Remarquez d'une part que le dossier référencé (ici \path{TW\_conf}) doit exister -- il ne sera pas créé -- et d'autre part l'utilisation de \verb|/| même sous Windows (et non de la contre-oblique \verb+\+). - -Si on désire mettre le dossier ressource dans le dossier du programme, comme sous-dossier, on peut utiliser une instruction qui prendra la forme \verb|inipath=./TW\_conf/|; cette référence et les autres formes de références relatives sont toujours par rapport au dossier programme de \Tw (sous Mac OS~X, le dossier contenant le module app est utilisé.) - -On pourrait aussi ajouter une première ligne:\index{configuration!defaultbinpaths} -\begin{verbExample} -defaultbinpaths=C:/Program Files/MiKTeX 2.7/miktex/bin -\end{verbExample} -pour indiquer où se trouve les programmes de la distribution \TeX; cependant cette instruction n'est pas encore pleinement opérationnelle en particulier sous Windows. - +% !TEX encoding = UTF8 +% !TEX root = manuel.tex +% !TEX spellcheck = fr_FR + +\chapter{Aller plus loin: autres outils} + +\section{Passage source/vue: SyncTeX}\index{SyncTeX} +\label{sec.synctex} + +Lorsqu'on lit le document dans la fenêtre de prévisualisation et qu'on remarque quelque chose à changer, il est intéressant de passer directement au même endroit dans la source. Pour faire cela il suffit de cliquer à l'endroit souhaité de la vue en maintenant la touche \keysequence{Ctrl} enfoncée; le curseur se déplacera et mettra en surbrillance l'endroit recherché dans la source. De même inversement, si on a déjà affiché la vue et que, retourné dans la source on s'y est déplacé, \keysequence{Ctrl+LMB} mettra en surbrillance la même ligne dans la vue. \footnote{Il est aussi possible d'utiliser un clic-droit (\keysequence{RMB}) pour ouvrir le menu contextuel et choisir \og{}Aller au PDF\fg{} ou \og{}Aller à la source\fg.} + +\begin{OSWindows} +Ici une remarque pour les utilisateurs de Windows: ceci ne fonctionne que si \textbf{tous} les noms de dossier/fichiers/\dots \textbf{ne} contiennent \textbf{pas} de caractères accentués. Si, par exemple, votre document est dans \texttt{C:\textbackslash Documents and Settings\textbackslash Propriétaire\textbackslash My Documents\textbackslash these} cela ne fonctionnera pas à cause du \verb|é| de \texttt{Propriétaire}! +\end{OSWindows} + +\section{Chaînes de commande particulières} + +Des lignes de commentaires, au tout début du document, peuvent être utilisées pour régler deux autres aspects de la compilation. + +\Tw{} utilise par défaut l'encodage \og utf-8\fg\index{encodage!utf-8} quand il charge et sauvegarde les fichiers, mais certains fichiers pourraient être encodés dans un autre format. Des encodages très communs sont ``latin1''\index{encodage!latin1}, qui est l'encodage prépondérant pour les langues d'Europe de l'Ouest sous Winsows, et ``Apple Roman'' prépondérant sous Mac. + +Pour définir un autre encodage\index{encodage} pour un fichier en particulier on peut mettre en début de ce fichier:\index{\verb+% "!TeX+!\verb+encoding+} +\begin{verbExample} +% !TeX encoding = latin1 +\end{verbExample} + +Notez que sans cette linge, vous devez spécifier manuellement à \Tw{} l'encodage correct. Sinon, vos données pourraient être corrompues! Pour passer au-dessus du choix d'encodage par défaut de \Tw, utilisez le menu qui apparaît lorsque vous cliquez sur le bouton central de la barre de statut de la fenêtre d'édition. + +Si vous avez ouvert dans \Tw{} un fichier qui n'avait pas été sauvegardé en utf-8 mais auquel il manque la ligne \verb+% !TeX encodage+, il peut être affiché avec des caractères bizarres\index{caractères bizarres|see{encodage}}. Dans ce cas, vous pouvez spécifier de la même façon l'encodage correct par le bouton de la barre de statut, mais il est \emph{impératif} d'alors utiliser \menu{Recharger en utilisant l'encodage sélectionné} du même menu! Cela oblige \Tw{} de ré-ouvrir le document avec l'encodage souhaité, les caractères bizarres devraient être remplacés par des caractères normaux et c'est seulement à ce moment qu'il est sûr de continuer à travailler. Pour éviter de devoir répéter ce processus chaque fois que vous ouvrez ce fichier, vous devriez soit basculer en utf-8 pour le sauvegarder soit ajouter une ligne adéquate \verb+% !TeX encodage+. + +Si on veut compiler une fichier par un autre programme que le programme \TeX{} ou \LaTeX{} par défaut\index{programme!par défaut}, on mettra au début du fichier: +\index{\verb+% "!TeX+!\verb+program+} +\begin{verbExample} +% !TeX program = <le_programme> +\end{verbExample} +%\index{instruction \instex!programme} +par exemple: +\begin{verbExample} +% !TeX program = xelatex +\end{verbExample} + +Faites attention avec cette dernière instruction: vous devez utiliser ici le nom du programme qui doit être utilisé pour l'ensemble du projet, car c'est le nom de programme qui est le premier vu (celui du sous-document dans lequel vous êtes lorsque vous commencez la composition) qui sera utilisé. \Tw{} utilisera ce programme, même si un autre nom apparaît dans le document principal! + +Lorsqu'un document est ouvert avec une ligne \verb+% !TeX programme+, celui-ci devient le programme à utiliser et son nom apparaît dans la liste déroulante de la Barre d'outils; mais vous pouvez cependant outrepasser cela en choisissant un programme différent dans la liste déroulante, si vous le désirez. + +\needspace{3\baselineskip} +De plus, vous pouvez définir la langue de correction orthographique par une ligne de commentaire similaire: +\index{\verb+% "!TeX+!\verb+spellcheck+} +\begin{verbExample} +% !TeX spellcheck = <language_code> +\end{verbExample} +Les codes de langue disponibles sur votre système sont listés entre parenthèses dans \menu{Édition}\submenu\menu{Vérification orthographique} à côté du nom de la langue en toutes lettres. + +\needspace{6\baselineskip} +\section{Mise en forme de la source pour la lisibilité} + +Pour faciliter la lisibilité de la source, on peut utiliser l'indentation\index{edition@édition!indentation} comme le font les programmeurs: +\begin{verbExample} +\begin{itemize} + \item Premier élément de la liste; + \item deuxième élément; + \item dernier élément: + \begin{itemize} % début de sous-liste + \item premier sous-élément; + \item deuxième sous-élément. + \end{itemize} +\end{itemize} +\end{verbExample} + +Cela améliore la lisibilité, mais ne fonctionne bien que sur des lignes courtes, sans passage à la ligne automatique; ou si on demande de ne pas passer à la ligne par \menu{Format}\submenu\menu{Passage à la ligne}\index{coupure de ligne!automatique}. + +La commande \menu{Format}\submenu\menu{Indenter} ou le raccourci \keysequence{Ctrl+]} (macOS: \keysequence{Cmd+]}) vont indenter la ligne, ou les lignes sélectionnées, de quatre caractères en insérant un caractère tabulation. On peut répéter l'opération pour augmenter le retrait. + +Pour supprimer une indentation: \menu{Format}\submenu\menu{Supprimer l'indentation} ou par le raccourci \keysequence{Ctrl+[} (\keysequence{Cmd+[} sur macOS). \footnote{Voir les raccourcis modifiés pour les claviers qui ne permettent pas ces actions.} + +Comme \textsl{indent} n'indente que la première ligne d'un texte multiligne (si on demande la passage à la ligne), ceci n'est pas vraiment utile. Mais on peut demander à \Tw{} de scinder une longue ligne (plus longue que la largeur du panneau d'édition) en lignes plus courtes et en y ajoutant des retours à la ligne physiques (insertion du caractère retour à la ligne): \emph{\menu{Format}\submenu\menu{Retour à la ligne physique\dots}}\index{coupure de ligne!physique} ouvre une boîte de dialogue dans laquelle vous pouvez spécifier la largeur des lignes; vous pouvez aussi re-formater des lignes qui ont déjà été scindées. +% +%\begin{center} +%\includegraphics[scale=.8]{hardwrap} +%\end{center} + +\section{Afficher les balises}\index{balises} + +Quand un document devient un peu long et qu'on veut se déplacer à un endroit précis (un chapitre, une section, une sous-section,\dots), il faut faire défiler la fenêtre d'édition pour trouver l'endroit recherché\index{balises!structure}, ou utiliser le dialogue Rechercher si vous vous souvenez d'un mot clé dans le titre du chapitre. + +Dans le même but, plus confortablement, on peut aussi afficher les balises de structure du document: l'option de menu \menu{Fenêtre}\submenu\menu{Montrer}\submenu\menu{Balise} ouvre un panneau à gauche de la zone d'édition montrant les informations détectées par \Tw. Un clic sur le niveau recherché sélectionne la partie correspondante dans la source. Ce panneau, comme tout panneau, peut être redimensionner en tirant sa bordure. + +%On peut également plus ou moins développer la structure si elle est vraiment très longue en cliquant sur le petit carré avec \og-\fg{} pour réduire/fermer une structure et sur le carré avec \og+\fg{} pour l'ouvrir. + +La même opération peut se faire dans la vue PDF par \menu{Fenêtre}\submenu\menu{Visuali\-sation}\submenu\menu{Table des matières}\index{balises!table des matières}, mais cela ne sera actif que si on a créé des balises de structure dans le fichier PDF par le module \verb|hyperref|. + +\section{Organiser les fenêtres}\index{fenêtres} + +Par défaut, la fenêtre d'édition (source) s'ouvre à gauche et la fenêtre de vue (lorsque le fichier PDF correspondant existe), à droite en partageant l'écran en deux. + +On peut changer la position des fenêtres par le menu \menu{Fenêtre}. \submenu\menu{Mosaï\-que} et \submenu\menu{Côte à côte} donnent le effet par défaut si on n'a qu'un document ouvert. Sinon \submenu\menu{Mosaïque} crée une mosaïque de toutes les fenêtres. Les autres options permettent de présenter les fenêtres selon sa convenance. On peut, évidemment, aussi toujours re-dimensionner et déplacer manuellement les fenêtres. + +Pour la vue on peut aussi changer la présentation et donc l'agrandissement\index{zoom|see{agrandissement}}\index{agrandissement} par \menu{Vue}\submenu\menu{Taille réelle}, \submenu\menu{Ajuster à la largeur} et \submenu\menu{Ajuster à la fenêtre}; on peut également effectuer des zoom positifs et négatifs. Des raccourcis clavier existent pour toutes ces actions et sont donnés à côté de l'option dans le menu. + +\section{Nettoyer le dossier de travail}\index{nettoyer le dossier} +\label{sec:remove-aux-files} + +Rapidement, lorsqu'on utilise \AllTeX, on découvre que le dossier de travail est encombré de fichiers qui ont le même nom que la source mais avec une extension différente: \path{.aux}, \path{.log}, \path{.toc}, \path{.lof}+, \path{.lot}, \path{.bbl},\dots + +Tous ces fichiers sont nécessaires à \AllTeX{} pour pouvoir créer la table des matières, les listes de figures/tableaux, la bibliographie, les références croisées et, également très important, pour avoir une trace de ce qu'il a fait (le fichier \path{.log}.) + +En dehors des fichiers externes, images, illustrations,\dots , les seuls fichiers nécessaires sont les fichiers \path{.tex}, les sources du document. On peut effacer tous les autres. Parfois cela est même nécessaire lorsque \AllTeX{} se bloque suite à une erreur. + +Ceci peut être fait par le commande \Tw{} du menu \menu{Fichier}: \submenu\menu{Supprimer les Fichiers Auxiliaires\dots}\index{nettoyer un dossier!fichiers auxiliaires}. + +Lorsque vous lancez cette commande, une boîte de dialogue s'ouvre dans laquelle vous pouvez cocher/décocher les fichiers que vous voulez enlever \footnote{Le nom du fichier principal est utilisé pour créer la liste des candidats possibles à la suppression.}. La boîte de dialogue ne ferra la liste que des fichiers actuellement dans le dossier; si vous les avez tous supprimés, vous aurez un message précisant qu'il n'y a pas de fichier à supprimer à ce moment. + +La liste des fichiers auxiliaires qui vous est proposée se trouve dans le fichier de configuration \path{texworks-config.txt}\index{configuration!texworks-config.txt} du sous-dossier \path{configuration} du dossier ressource de \Tw. Vous pourriez en ajouter si nécessaire. +%\newpage + +\section{Usage Portable \& Modifier la configuration}\index{configuration}\index{Usage Portable}\index{installation!Usage Portable} +\label{sec.portable_configuration} + +Nous avons vu à la section \ref{chap.installation} (page \pageref{chap.installation}) que lors du premier lancement \Tw{} crée un dossier ressource, de même qu'il sauvegarde les informations de préférences. + +Il est cependant possible de définir soi-même l'endroit où on veut le dossier ressource et la sauvegarde des préférences. Cela peut être intéressant lorsqu'on veut un système portable (par exemple sur une clé USB) ou que l'on veut accéder facilement par exemple au dossier des modèles ou des mors clé de complétion. + +Par cela, créer dans le dossier du programme un fichier \path{texworks-setup.ini}\index{configuration!texworks-setup.ini} dans lequel on donnera la localisation des dossier contenant les sous-dossiers de complétion, configuration, dictionnaires,\dots et le fichier de configuration (\path{texworks.ini}\index{configuration!texworks.ini}); il y aura deux lignes: +\begin{verbExample} +inipath=C:/mondossier/TW_conf/ +libpath=C:/mondossier/TW_conf/\index{configuration!libpath} +\end{verbExample} + +\verb|inipath|\index{configuration!inipath} pour le fichier de configuration et \verb|libpath|\index{configuration!libpath} pour les dossiers nécessaires. Ici \path{TW\_conf} remplacerait le dossier ressource \path{TeXworks}. Remarquez d'une part que le dossier référencé (ici \path{TW\_conf}) doit exister -- il ne sera pas créé -- et d'autre part l'utilisation de \verb|/| même sous Windows (et non de la contre-oblique \verb+\+). + +Si on désire mettre le dossier ressource dans le dossier du programme, comme sous-dossier, on peut utiliser une instruction qui prendra la forme \verb|inipath=./TW\_conf/|; cette référence et les autres formes de références relatives sont toujours par rapport au dossier programme de \Tw (sous macOS, le dossier contenant le module app est utilisé.) + +On pourrait aussi ajouter une première ligne:\index{configuration!defaultbinpaths} +\begin{verbExample} +defaultbinpaths=C:/Program Files/MiKTeX 2.7/miktex/bin +\end{verbExample} +pour indiquer où se trouve les programmes de la distribution \TeX; cependant cette instruction n'est pas encore pleinement opérationnelle en particulier sous Windows. + diff -Nru texworks-manual-20200329/src/fr/backmatter.tex texworks-manual-20210308/src/fr/backmatter.tex --- texworks-manual-20200329/src/fr/backmatter.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/backmatter.tex 2021-03-08 17:33:22.000000000 +0100 @@ -6,7 +6,7 @@ Microsoft, Windows, et le logo Windows sont des marques déposées de Microsoft Corporation aux États Unis et autres pays. -Apple, Mac, et Mac OS sont des marques déposées de Apple Inc., enregistrés aux États Unis et d'autres pays. +Apple, Mac, et macOS sont des marques déposées de Apple Inc., enregistrés aux États Unis et d'autres pays. GitHub est une marque déposée de GitHub Inc. diff -Nru texworks-manual-20200329/src/fr/customizing.tex texworks-manual-20210308/src/fr/customizing.tex --- texworks-manual-20200329/src/fr/customizing.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/customizing.tex 2021-03-08 17:33:22.000000000 +0100 @@ -44,7 +44,7 @@ L'utilisation des raccourcis clavier\index{raccourcis clavier} facilite grandement la saisie de la source et la gestion de celle-ci et de la vue. pour des actions fréquemment répétées, leur utilisation est beaucoup plus efficace que l'utilisation de la souris sur des boutons de barres d'outils. -Nous donnons ci-après les raccourcis clavier pour le travail dans la source et pour celui dans la vue. Notez que sous Mac OS X, \verb|Ctrl| fait en réalité référence à la \emph{touche Commande}, qui est le modificateur habituel des raccourcis clavier. Bien que les raccourcis clavier soient spécifiés avec \verb|Ctrl|, celui-ci apparaîtra comme la \emph{touche Commande} dans les menus. (Pour faire vraiment référence à la \emph{touche Contrôle} sur la Mac, le fichier de définitions doit utiliser le nom \verb|Meta|.) +Nous donnons ci-après les raccourcis clavier pour le travail dans la source et pour celui dans la vue. Notez que sous macOS, \verb|Ctrl| fait en réalité référence à la \emph{touche Commande}, qui est le modificateur habituel des raccourcis clavier. Bien que les raccourcis clavier soient spécifiés avec \verb|Ctrl|, celui-ci apparaîtra comme la \emph{touche Commande} dans les menus. (Pour faire vraiment référence à la \emph{touche Contrôle} sur la Mac, le fichier de définitions doit utiliser le nom \verb|Meta|.) Notez que les définitions ci-dessous sont celles par défaut de la version originelle en anglais. Des langues différentes peuvent utiliser des raccourcis différents.%, ainsi que quelques changements pour la version francisée du logiciel \footnote{du moins une version de travail des raccourcis francisés, car il y a des problèmes suivant les systèmes et les habitudes des utilisateurs!}; en effet la combinaison de \verb|Ctrl| et de \verb|\| ou \verb|[| n'est pas possible sur un clavier Azerty. Lorsque les raccourcis sont les mêmes, \og --\fg{} est mis dans la colonne francisée. @@ -108,8 +108,11 @@ Pour la fenêtre de vue: \input menuactionsPDFDocument.tex -\subsection{Autres actions} -En plus des actions listées ci-dessus, il y a aussi des actions pour les scripts. Celles-ci sont dynamiques par nature, comme elles sont créées à la volée pour les scripts disponibles (elles pourront changer lorsque vous installerez, supprimerez ou modifierez des scripts.) Toutes ces actions sont de la forme \verb*|Script: <script_titre>|, où \verb*|<script_titre>| doit être modifié de façon appropriée. Si vous avez un script qui apparaît comme \verb|Mon Script|, l'action correspondante sera appelée \verb*|Script: Mon Script|. +\subsection{Actions pour les outils de composition} +En plus des actions statiques listées ci-dessus, il y a aussi des actions pour activer un outil de composition. Toutes ces actions sont de la forme générale \verb*|actionTypesetTool<nom_outil| où \verb*|<nom_outil>| doit être remplacé de façon appropriée. Par exemple, le nom correspondant à l'outil de composition \verb*|pdfLaTeX| est \verb*|actionTypesetToolpdfLaTeX|, celui correspondant à \verb*|Mon outil| est \verb*|actionTypesetToolMon outil|.\footnote{Noter que certains caractères (comme \verb*|=| et \verb*|;| sont réservés dans les fichiers ini et doivent avoir un échappement par \verb*|%XX|, où \verb*|XX| est le code hexadécimal ASCII correspondant. Par exemple, le nom correspondant à \verb*|A=B| est \verb*|actionTypesetToolA%3DB|.} + +\subsection{Actions pour les scripts} +Il y a aussi des actions pour les scripts. Elles sont dynamiques par nature, comme elles sont créées à la volée pour les scripts disponibles (qui peuvent changer quand vous installez des scripts, les retirez ou changez les paramètres.) Toutes ces actions sont de la forme \verb*|Script: <titre_script>|, où \verb*|<titre_script>| doit être remplacé de façon appropriée. Si vous avez un script qui se nomme \verb|Mon Script|, par exemple, l'action correspondante sera appelée \verb*|Script: Mon Script|. \section{Les mots clé de complétion} diff -Nru texworks-manual-20200329/src/fr/frontmatter.tex texworks-manual-20210308/src/fr/frontmatter.tex --- texworks-manual-20200329/src/fr/frontmatter.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/frontmatter.tex 2021-03-08 17:33:22.000000000 +0100 @@ -7,7 +7,7 @@ \setcounter{page}{0} \DocumentCopyright{\footnotesize -Copyright {\copyright} 2010--2019 Alain Delmotte, Stefan Löffler et contributeurs. Certains droits réservés. +Copyright {\copyright} 2010--2021 Alain Delmotte, Stefan Löffler et contributeurs. Certains droits réservés. Ce manuel est une documentation libre: vous pouvez la distribuer et/ou la modifier suivant les termes, soit (i) de la “CC-BY-SA license” telle que publiée par Creative Commons (soit la version 3 de la Licence, ou (à votre convenance) toute version ultérieure) diff -Nru texworks-manual-20200329/src/fr/html/Makefile texworks-manual-20210308/src/fr/html/Makefile --- texworks-manual-20200329/src/fr/html/Makefile 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/html/Makefile 2021-03-08 17:33:22.000000000 +0100 @@ -58,12 +58,12 @@ @echo "Creating image $@ (from $<)" @mkdir -p images # Some versions of convert refuse to produce .eps files due to security concerns - @convert "$<" "$@" $(SUPRESSOUT) 2$(SUPRESSOUT) || convert "$<" ppm: | pnmtops -noturn | eps2eps - "$@" + @convert "$<" "$@" $(SUPRESSOUT) 2$(SUPRESSOUT) || convert "$<" ppm:- | pnmtops -noturn | eps2eps - "$@" images/%.eps : ../images/%.jpg @echo "Creating image $@ (from $<)" @mkdir -p images # Some versions of convert refuse to produce .eps files due to security concerns - @convert "$<" "$@" $(SUPRESSOUT) 2$(SUPRESSOUT) || convert "$<" ppm: | pnmtops -noturn | eps2eps - "$@" + @convert "$<" "$@" $(SUPRESSOUT) 2$(SUPRESSOUT) || convert "$<" ppm:- | pnmtops -noturn | eps2eps - "$@" index.ind : images $(SOURCES) manual.cfg tex4ht.env diff -Nru texworks-manual-20200329/src/fr/installation.tex texworks-manual-20210308/src/fr/installation.tex --- texworks-manual-20200329/src/fr/installation.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/installation.tex 2021-03-08 17:33:22.000000000 +0100 @@ -1,65 +1,66 @@ -% !TEX encoding = UTF8 -% !TEX root = manuel.tex - -\chapter{Installation} -\index{installation} -\label{chap.installation} - -\Tw{} n'est qu'un éditeur de texte; pour pouvoir créer des documents avec \AllTeX{} et les composer en PDF, nous avons besoin de ce qu'on appelle une distribution \TeX\index{TeX distribution@{\TeX} distribution}\index{TeX@\TeX!distribution|see {{\TeX} distribution}}. C'est un ensemble de programmes et autres fichiers complémentaires qui seront appelés automatiquement par \Tw{} durant son travail. Il faut donc installer une distribution; nous le ferrons \emph{avant} de lancer \Tw{} la première fois pour que celui-ci trouve automatiquement ce dont il a besoin. - -On peut utiliser \textbf{TeX~Live\index{TeX distribution@{\TeX} distribution!TeX~Live}} (\url{http://www.tug.org/texlive/}), une combinaison de teTex, MacTeX et XEmTeX, est disponible pour les trois systèmes d'exploitation (Linux, Mac OS X, Windows). Notez que vous avez besoin d'une distribution relativement récente de TeX~Live (2012 ou suivante au moment d'écriture) pour utiliser toutes les possibilités de {\Tw}. - -\begin{OSLinux} -Pour Linux\index{TeX distribution@{\TeX} distribution!Linux}: la plupart des distributions ont une distribution \TeX, elle peut cependant ne pas être installée de base et il faudra utiliser les outils de gestion Linux pour le faire. En outre, on peut télécharger et installer TeX~Live directement à partir de \url{http://www.tug.org/texlive/}. -\end{OSLinux} -\vspace{6pt} - -\begin{OSMac} -Pour le Mac\index{TeX distribution@{\TeX} distribution!Mac}: \textbf{MacTeX}\index{TeX distribution@{\TeX} distribution!Mac!MacTeX}, une nouvelle distribution basée sur gwTeX et XeTeX est disponible; \url{http://www.tug.org/mactex/}. -\end{OSMac} -\vspace{6pt} - -\begin{OSWindows} -Pour Windows\index{TeX distribution@{\TeX} distribution!Windows}: une distribution souvent utilisée est \textbf{MiKTeX\index{TeX distribution@{\TeX} distribution!Windows!MikTeX}} (\url{http://www.miktex.org/}). MiKTeX dispose d'un programme de mise-à-jour de la distribution qui a aussi été portée sur Linux. On peut aussi utiliser la distribution \textbf{XEmTeX} (\url{http://www.xemtex.org/}). -\end{OSWindows} - -\section{Sous Windows}\index{installation!Windows} - -La plupart des grandes distributions \TeX{} ont déjà un module \Tw. Parfois ces versions ont des améliorations spécifiques pour la distribution. C'est pourquoi il est préférable pour installer \Tw{} sur Windows d'utiliser le gestionnaire de modules de votre distribution. Dans ce cas, vous pouvez sauter les quelques paragraphes qui suivent. Mais, cependant, lisez la fin de cette section car elle fournit des indications sur la manière d'adapter \Tw{} à vos besoins. - -Si vous voulez obtenir une version \og officielle\fg, téléchargez le système setup de \Tw{} à partir de \url{http://tug.org/texworks/} après installation de la distribution \TeX. - -Installer simplement \Tw{} en exécutant le fichier setup. Durant l'installation, on vous demandera où vous désirez installer le programme, si vous désirez créer des raccourcis et si vous voulez toujours ouvrir les fichiers \path{.tex} avec \Tw. Il y a des valeurs par défaut correctes qui devraient fonctionner pour la plupart des utilisateurs. - -Si vous voulez avoir un contrôle complet sur où et comment \Tw{} est localisé, vous pouvez aussi télécharger l'archive \path{.zip} à partir du site web et la désarchiver où voulez. Notez que dans ce cas les raccourcis et les associations de fichiers doivent être créés manuellement. - -\urldef{\TwRegistryPath}\path{\HKEY_USERS\S-\dots\Software\TUG\TeXworks} - -Lorsque le programme sera lancé pour la première fois il créera un dossier \path{TeXworks}\index{dossier!TeXworks}\index{dossier!ressource} dans le répertoire associé à votre compte d'utilisateur \footnote{sous Windows XP: votre dossier home est \path{C:\Documents and Settings\<votre nom>}, sous Vista et Windows 7 c'est: \path{C:\Users\<your name>}.}. Ce dossier contiendra quelques sous-dossiers pour les fichiers d'auto-complé\-tion\index{dossier!auto-complétion}, de configuration\index{dossier!configuration}, des dictionnaires\index{dossier!dictionnaires} orthographiques éventuels, des modèles\index{dossier!modèles} de documents et des traductions\index{dossier!traductions} d'interface -- nous verrons tout cela en temps utile \footnote{\Tw{} enregistrera ses préférences dans le registre: -\TwRegistryPath. Si elles sont supprimés, elles seront recréés avec des valeurs par défaut à l'utilisation suivante.}. - -NB. Jusqu'à la version utilisée ici, le fait que le dossier principal du compte de l'utilisateur (\path{<votre nom>}), dans \og Documents and Settings\fg, comprenne des caractères non-ASCII (comme des lettres accentuées), empêchera la correction orthographique et la synchronisation entre la source et le \path{.pdf}. - -\section{Sous Linux}\index{installation!Linux} - -Plusieurs distributions Linux courantes ont déjà des modules \Tw. Ils sont adaptés à la plupart des utilisateurs et facilitent considérablement l'installation de \Tw. - -Si votre distribution ne fournit pas de modules adéquats et récents, vous devrez construire vous-mêmes \Tw{} à partir des sources, ce qui est vraiment facile sous Linux. Après installation de la distribution \TeX, allez à \url{https://github.com/TeXworks/texworks/wiki/Building} et suivez les instructions adaptées à votre distribution Linux. Voyez aussi la section \ref{sec.compiling}. - -Une fois la compilation réussie, lancer \Tw{}. Les dossiers \path{.TeXworks}\index{dossier!.TeXworks} et \path{.config/TUG}\index{dossier!.config/TUG} seront créés dans votre répertoire home. - -\section{Sous Mac OS}\index{installation!Mac} - -Si vous désirez obtenir une version \og officielle\fg{}, récupérez \Tw{} en téléchargeant l'archive du site de \Tw{} \url{http://tug.org/texworks/} après installation de la distribution {\TeX}. - -C'est un module autonome, \texttt{.app}, qui ne requière pas l'installation de fichiers Qt dans \path{/Library/Frameworks}, ou d'autres librairies dans \path{/usr/local/lib}. Copiez juste l'\path{.app} où vous voulez et lancez le. - -Le répertoire ressource\index{dossier!ressource Mac} \Tw{} sera créé dans votre répertoire \path{Library} (\path{~/Library/.TeXworks/}) de votre répertoire home. Les préférences, que vous pouvez supprimer si cela crée des problèmes, sont sauvegardées dans \path{~/Library/Preferences/org.tug.TeXworks.plist} . - -\section{Prêts!} - -Enfin quelques fichiers pourront être ajoutés aux fichiers \og propres\fg{} à \Tw. Comme la localisation dépend de votre plateforme, nous y ferrons référence, dans ce manuel, comme \path{<ressources>}\index{folder!$\langle$resources$\rangle$} ou le \textbf{dossier ressources \Tw}. -Par défaut, sous Linux il s'agit de \path{~/.TeXworks}, sous Windows~XP c'est \path{C:\Documents and Settings\<votre nom>\TeXworks}, sous Windows Vista/7 c'est \path{C:\Users\<votre nom>\TeXworks}, et sur Mac c'est \path{~/Library/TeXworks/}. -Le moyen le plus facile pour localiser ce dossier, dans les versions récentes de \Tw, est d'utiliser \menu{Aide}, option \submenu\menu{Paramètres et ressources\dots}. Cela ouvre une boîte de dialogue qui montre où \Tw{} enregistre ses paramètres et cherche les ressources. - -Après l'installation et la première utilisation, jetez un œil aux sous-dossiers du dossier ressource de \Tw{} et effacer tous les fichiers \path{qt_temp.xxxx}; ce sont des fichiers temporaires abandonnés là et ils pourraient interférer par après avec les fichiers normaux qui sont installés dans le même dossier. +% !TEX encoding = UTF8 +% !TEX root = manuel.tex + +\chapter{Installation} +\index{installation} +\label{chap.installation} + +\Tw{} n'est qu'un éditeur de texte; pour pouvoir créer des documents avec \AllTeX{} et les composer en PDF, nous avons besoin de ce qu'on appelle une distribution \TeX\index{TeX distribution@{\TeX} distribution}\index{TeX@\TeX!distribution|see {{\TeX} distribution}}. C'est un ensemble de programmes et autres fichiers complémentaires qui seront appelés automatiquement par \Tw{} durant son travail. Il faut donc installer une distribution; nous le ferrons \emph{avant} de lancer \Tw{} la première fois pour que celui-ci trouve automatiquement ce dont il a besoin. + +\textbf{TeX~Live\index{TeX distribution@{\TeX} distribution!TeX~Live}} (\url{http://www.tug.org/texlive/}), une combinaison de teTex, MacTeX et XEmTeX, est disponible pour les trois systèmes d'exploitation (Linux, macOS, Windows). + +\begin{OSLinux} +Pour Linux\index{TeX distribution@{\TeX} distribution!Linux}: la plupart des distributions ont une distribution \TeX, elle peut cependant ne pas être installée de base et il faudra utiliser les outils de gestion Linux pour le faire. En outre, on peut télécharger et installer TeX~Live directement à partir de \url{http://www.tug.org/texlive/}. +\end{OSLinux} +\vspace{6pt} + +\begin{OSMac} +Pour le Mac\index{TeX distribution@{\TeX} distribution!Mac}: \textbf{MacTeX}\index{TeX distribution@{\TeX} distribution!Mac!MacTeX}, une distribution basée sur gwTeX et XeTeX est disponible; voir \url{http://www.tug.org/mactex/}. +\end{OSMac} +\vspace{6pt} + +\begin{OSWindows} +Pour Windows\index{TeX distribution@{\TeX} distribution!Windows}: une distribution très populaire est \textbf{MiKTeX\index{TeX distribution@{\TeX} distribution!Windows!MikTeX}} (\url{http://www.miktex.org/}). MiKTeX dispose d'un programme de mise-à-jour de la distribution qui a aussi été portée sur Linux. +\end{OSWindows} + +Pour des détails sur une usage portable et le changement des localisations de la configuration locale, veuillez vous reportez à la section Usage Portable \& Modifier la configuration -- section \ref{sec.portable_configuration} (à la page \pageref{sec.portable_configuration}). + +\section{Sous Windows}\index{installation!Windows} + +La plupart des grandes distributions \TeX{} ont déjà un module \Tw. Parfois ces versions ont des améliorations spécifiques pour la distribution. C'est pourquoi il est préférable pour installer \Tw{} sur Windows d'utiliser le gestionnaire de modules de votre distribution. Dans ce cas, vous pouvez sauter les quelques paragraphes qui suivent. Mais, cependant, lisez la fin de cette section car elle fournit des indications sur la manière d'adapter \Tw{} à vos besoins. + +Si vous voulez obtenir une version \og officielle\fg, téléchargez le système setup de \Tw{} à partir de \url{http://tug.org/texworks/} après installation de la distribution \TeX. + +Installer simplement \Tw{} en exécutant le fichier setup. Durant l'installation, on vous demandera où vous désirez installer le programme, si vous désirez créer des raccourcis et si vous voulez toujours ouvrir les fichiers \path{.tex} avec \Tw. Il y a des valeurs par défaut correctes qui devraient fonctionner pour la plupart des utilisateurs. + +Si vous voulez avoir un contrôle complet sur où et comment \Tw{} est localisé, vous pouvez aussi télécharger l'archive \path{.zip} à partir du site web et la désarchiver où voulez. Notez que dans ce cas les raccourcis et les associations de fichiers doivent être créés manuellement. + +\urldef{\TwRegistryPath}\path{\HKEY_CURRENT_USER\Software\TUG\TeXworks} + +Lorsque vous lancez {\Tw} pour la première fois, il crèe un dossier appelé \path{C:\Users\<votre nom>\AppData\Roaming\TUG\TeXworks}\index{folder!resource}. Ce dossier contiendra quelques sous-dossiers pour les fichiers d'auto-complétion\index{folder!auto-completion}, de configuration\index{folder!configuration}, des dictionnaires\index{folder!dictionaries}, des modèles\index{folder!templates}, et de la traduction/localisation de l'interface\index{folder!translations} ---nous verrons cela en plus de détails plus loin.\footnote{{\Tw} sauvegardera ses préférences dans le registre: +\TwRegistryPath. Si elles sont supprimés, elles seront recréés avec des valeurs par défaut à l'utilisation suivante.}. + +NB. Au moment de la rédaction, si \path{<your name>} contient des caractères non-ASCII (par exemple des caractères accentués), quelque fonctions de {\Tw} pourrais ne pas fonctionner correctement. Par exemple, la vérification orthographique et la synchronisation aller/retour entre la source et le \path{.pdf} seront affectés. + +\section{Sous Linux}\index{installation!Linux} + +Plusieurs distributions Linux courantes ont déjà des modules \Tw. Ils sont adaptés à la plupart des utilisateurs et facilitent considérablement l'installation de \Tw. + +Si votre distribution ne fournit pas de modules adéquats et récents, vous devrez construire vous-mêmes \Tw{} à partir des sources, ce qui est vraiment facile sous Linux. Après installation de la distribution \TeX, allez à \url{https://github.com/TeXworks/texworks/wiki/Building} et suivez les instructions adaptées à votre distribution Linux. Voyez aussi la section \ref{sec.compiling}. + +Une fois le programme installé, lancez {\Tw}. Les dossiers \path{.local/share/TUG/TeXworks}\index{folder!resource} et \path{.config/TUG} seront créés dans votre dossier. + +\section{Sous macOS}\index{installation!Mac} + +Si vous désirez obtenir une version \og officielle\fg{}, récupérez \Tw{} en téléchargeant l'archive du site de \Tw{} \url{http://tug.org/texworks/} après installation de la distribution {\TeX}. + +C'est un module autonome, \texttt{.app}, qui ne requière pas l'installation de fichiers Qt dans \path{/Library/Frameworks}, ou d'autres librairies dans \path{/usr/local/lib}. Copiez juste l'\path{.app} où vous voulez et lancez le. + +Sur macOS, le dossier ressource de {\Tw} \index{folder!resource} sera créé dans votre dossier \path{Library} (\path{~/Library/Application Support/TUG/TeXworks}), à l'intérieur de votre dossier home. Les préférences sont enregistrées dans \path{~/Library/Preferences/org.tug.TeXworks.plist} +que vous pouvez supprimer si jamais vous suspectez qu'il cause des problèmes + +\section{Prêts!} + +Enfin, on pourait devoir ajouter quelques fichiers pourraient aux fichiers \og personal\fg{} que {\Tw} crée. Comme la localisation exacte de ceux-ci dépend de votre plateforme, on y fera référence comme \path{<resources>}\index{folder!resource} ou le \textbf{dossier ressource de {\Tw}} dans le cours de ce manuel. Par défaut sous Windows, c'est \path{C:\Users\<your name>\AppData\Roaming\TUG\TeXworks}, sous Linux c'est \path{.local/share/TUG/TeXworks}, et sous macOS c'est \path{~/Library/Application Support/TUG/TeXworks}. Le moyen le plus facile pour localiser ce dosiier dans les versions récentes de {\Tw} est d'utiliser l'entrée de \menu{Aide}\submenu\menu{Paramètres et Ressources\dots}. Elle ouvrer une boîte de dialogue qui montre où {\Tw} sauvegarde ses paramètres et où il cherche ses ressources. + +Après l'installation et la première utilisation, jetez un coup d'œil dans les sous-dossiers du dossier ressources de {\Tw} et supprimer tout fichier \path{qt_temp.xxxx} files; ce sont des fichiers temporaires abandonnés et ils pourraient interférer avec les fichiers normaux, qui sont installés, par après, dans le même dossier. diff -Nru texworks-manual-20200329/src/fr/introduction.tex texworks-manual-20210308/src/fr/introduction.tex --- texworks-manual-20200329/src/fr/introduction.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/introduction.tex 2021-03-08 17:33:22.000000000 +0100 @@ -1,72 +1,72 @@ -% !TEX encoding = utf8 -% !TEX root = manuel.tex -% !TEX spellcheck = fr_FR - -\chapter{Introduction} - -Donald E. Knuth\index{Knuth Donald E.} a décidé de créer un nouveau système typographique qui sera appelé \TeX\index{tex@\TeX}, parce que le système d'impression des volumes de son livre \emph{The Art of Computer Programming} avait changé; Knuth trouva horrible le résultat du nouveau système. - -Le but de \TeX{} était d'avoir un système qui produirait toujours les mêmes documents indépendamment de la machine utilisée. Knuth a aussi décrit la famille de fontes \emph{Computer Modern} et le langage \textsf{METAFONT}\index{metafont@\textsf{METAFONT}} de description de fontes. - -Le travail débuté en 1977 fut terminé (les langages ont été \og figés\fg) en 1989. \TeX{} et \textsf{METAFONT} n'évoluent plus sauf pour correction de bogues mineures (les versions de \TeX{} sont numérotées suivant les décimales de $\pi$ -- actuellement 3.1415926 -- et \textsf{METAFONT} les décimales du nombre \og e\fg{} -- actuellement 2.718281.) - -\TeX{} fournit des outils de base (commandes/instructions/\og primitives\fg) pour définir une typographie \footnote{pris ici au sens large de fontes et mise en page}; pratiquement tous les détails doivent être précisés, mais le langage permet de créer des macros pour des constructions répétées. C'est ainsi que des collections de macros sont chargées au moyen de fichiers \og format\fg\index{fichiers!format} (entre autres, de grandes collections de macros précompilées.) - -Knuth a créé un format de base par défaut (plus ou moins 600 commandes), c'est \emph{Plain\index{tex@\TeX!Plain} \TeX}. Celui-ci facilite la création des documents. - -Le format le plus utilisé est \LaTeX\index{tex@\TeX!\LaTeX} (Leslie Lamport\index{Lamport Leslie}, 1985), qui offre des commandes et des structures plus générales pour certains documents (article, book,\dots) permettant un travail plus facile et plus rapide, mais parfois avec moins de flexibilité à cause du cadre plus ou moins rigide. D'autres formats sont \AmS-\TeX\index{tex@\TeX!\AmS-\TeX}, \AmS-\LaTeX, ConTeXt\index{tex@\TeX!ConTeXt}, chacun ayant des buts et des avantages (et inconvénients) particuliers. - -Pour étendre le format, on charge des \og modules\fg{} qui sont des collections de macros spécifiques à certains aspects de la typographie. - -Depuis sa définition, fin des années 70, jusqu'à maintenant, dernière version en mars 2008, la famille \TeX{} a dû évoluer pour tenir compte des développements de la typographie en dehors du monde \TeX. - -Quelques uns des problèmes étaient/sont: -\begin{itemize} -\item prendre en compte d'autres langues avec des \og alphabets\fg{} plus étendus que l'ASCII\footnote{``American Standard Code for Information Interchange'': système d'encodage des caractères incluant seulment les caractères Latin trouvés en anglais, quelques caractères communs de ponctuation et quelques autres symboles tels que \% ou \$} ou tout aussi bien avec des alphabets non latins, -\item avoir plus de polices, il n'y a pas grande variété dans les polices créées avec \textsf{METAFONT} (peu de créateurs l'utilisent), -\item créer des documents dans d'autres formats que le DVI d'origine \footnote{Device Independent: format des fichiers produits par \TeX{} et indépendants du système.}, -\item utiliser les riches possibilités des autres systèmes et formats typographiques comme PostScript et PDF, -\item avoir plus de facilités de calcul et de création de scripts,\dots -\end{itemize} - -Pour répondre à ces demandes et d'autres, de nombreux \og moteurs\fg{} et programmes ont été créés autour de \TeX, par exemple: pdftex\index{tex@\TeX!pdftex}, pdflatex, dvips\index{tex@\TeX!dvips}, ps2pdf, \textsf{METAPOST}\index{metapost@\textsf{METAPOST}} pour ouvrir le monde \TeX{} aux possibilités de PostScript\index{PostScript} et PDF\index{PDF}, XeTeX\index{tex@\TeX!XeTeX} et XeLaTeX pour pouvoir utiliser des fontes \og normales\fg{} sur les différentes machines et pour être capable de gérer les systèmes d'écriture différents des systèmes gauche-droite originaires d'Europe (lettres latines et cyrilliques et associés) -- droite-gauche, vertical, pictogrammes,\dots --, LuaTeX\index{tex@\TeX!LuaTeX} et LuaLaTeX pour avoir un langage puissant de scripts. - -Mais pour utiliser \TeX{} et les systèmes de sa famille, on doit créer un document \og source\fg{}\index{document!source} car \TeX{} n'est qu'un système pour transformer un document source en un document (parfaitement!) mis en page. Cette source est un simple fichier texte avec des instructions de mise en forme typographique et on a besoin d'un programme pour la créer: \textbf{l'éditeur\index{editeur@éditeur}}. - -Il y a beaucoup d'éditeurs capables de créer une source \TeX, certains sont des éditeurs généraux, d'autres sont spécifiquement créés pour \TeX: c'est ici qu'intervient \Tw\index{texworks@\Tw}. -\bigskip - -\Tw{} est un projet de création d'un éditeur de texte utilisé pour les outils de la faille \TeX, nous nous référerons à ceux-ci comme \AllTeX. Plutôt que de créer une nouvelle incarnation d'éditeur sophistiqué, bardé de multiples barres d'outils pour subvenir à tous les besoins, \Tw{} cherche au contraire à proposer un éditeur dépouillé, n'offrant, à première vue que des outils limités à l'édition de texte ainsi qu'un bouton et un menu déroulant pour composer un texte en \AllTeX. - -L'idée de création de l'éditeur fait suite à une longue réflexion de \emph{Jonathan Kew\index{Kew Jonathan}}, initiateur en charge du projet, sur les raisons qui éloignent les utilisateurs potentiels de \AllTeX, ainsi que de l'observation du succès de l'éditeur \textbf{\TeX shop\index{texshop@\TeX shop}} sous environnement Mac. - -Enfin, le but est aussi de fournir un éditeur identique sur de nombreuses plates-formes logicielles; \Tw{} est actuellement disponible sous Linux, sous Mac OS ainsi que sous Windows. Dans tous les cas l'interface se présente sous la même forme et offre les mêmes fonctionnalités. -%\bigskip - -Après l'introduction, la deuxième section explique comment installer le logiciel. Dans le troisième on décrit l'interface et on crée un premier document montrant les bases d'utilisation de \Tw. Dans les quatrièmes et cinquièmes sections on aborde les outils de travail avancés proposés par \Tw{}; cette section n'est à lire que lorsqu'on a bien en main les bases du travail sous \Tw{}. Les outils avancés permettent d'être beaucoup plus efficace. La sixième section donne une brève introduction à l'écriture de scripts (ce qui dépasse le but de ce manuel, on trouvera des informations ailleurs.) Enfin la septième section fournit des pointeurs vers des informations complémentaires sur \TeX{} et des sources d'aide; ceci termine la partie principale du document. - -Enfin, les annexes fournissent des informations pour \og customiser\fg{} l'éditeur \Tw, sur les expressions régulières pour le système rechercher/remplacer et comment \Tw{} peut être compilé à partir des sources. Une courte bibliographie et un index terminent ce manuel. - -\section{Icônes et style} - -Parce qu'une image vaut souvent mieux que mille mots, des icônes et des styles particuliers sont utilisés dans tout le manuel pour éviter des paragraphes incommodes ou marquer certains points spéciaux. Les touches du clavier sont généralement représentées par\keystroke{A}, à l'exception de quelques touches spéciales. Ce sont:\keysequence{Shift},\keysequence{PgUp},\keysequence{PgDown},\keysequence{Return} (retour charriot),\keysequence{UArrow},\keysequence{DArrow},\keysequence{LArrow},\keysequence{RArrow},\keysequence{Spacebar} (espace),\keysequence{BSpace} (backspace) et \keysequence{Tab} (tab). - -De plus, les cliques de souris sont représentés par {\LMB} (clique gauche) et {\RMB} (clique droit; sur Mac OS X avec une souris à un bouton, cela est généralement réalisé en maintenant la touche {\Ctrl} tout en cliquant.) - -En dehors des instructions de saisie, de nombreux passages de ce manuel sont marqués avec un style particulier. - -\needspace{5\baselineskip} -Des informations valables seulement pour ou qui ne concernent qu'un système d'exploitation sont indiquées comme ceci: -\begin{OSWindows} -\noindent Ceci ne vous concerne que si vous utilisez Windows. \\ -Vous pouvez bien évidemment lire ces informations si vous utilisez un autre système d'exploitation. \\ -Ce ne sera que de peu d'usage pour vous. -\end{OSWindows} - -\bigskip -Les exemples de code sont donnés par une police de chasse fixe, style machine à écrire, avec des lignes au-dessus et en-dessous pour les séparer du reste du texte: -\begin{verbExample} -Hello \TeX-World! -\end{verbExample} - +% !TEX encoding = utf8 +% !TEX root = manuel.tex +% !TEX spellcheck = fr_FR + +\chapter{Introduction} + +Donald E. Knuth\index{Knuth Donald E.} a décidé de créer un nouveau système typographique qui sera appelé \TeX\index{tex@\TeX}, parce que le système d'impression des volumes de son livre \emph{The Art of Computer Programming} avait changé; Knuth trouva horrible le résultat du nouveau système. + +Le but de \TeX{} était d'avoir un système qui produirait toujours les mêmes documents indépendamment de la machine utilisée. Knuth a aussi décrit la famille de fontes \emph{Computer Modern} et le langage \textsf{METAFONT}\index{metafont@\textsf{METAFONT}} de description de fontes. + +Le travail débuté en 1977 fut terminé (les langages ont été \og figés\fg) en 1989. \TeX{} et \textsf{METAFONT} n'évoluent plus sauf pour correction de bogues mineures (les versions de \TeX{} sont numérotées suivant les décimales de $\pi$ -- actuellement 3.1415926 -- et \textsf{METAFONT} les décimales du nombre \og e\fg{} -- actuellement 2.718281.) + +\TeX{} fournit des outils de base (commandes/instructions/\og primitives\fg) pour définir une typographie \footnote{pris ici au sens large de fontes et mise en page}; pratiquement tous les détails doivent être précisés, mais le langage permet de créer des macros pour des constructions répétées. C'est ainsi que des collections de macros sont chargées au moyen de fichiers \og format\fg\index{fichiers!format} (entre autres, de grandes collections de macros précompilées.) + +Knuth a créé un format de base par défaut (plus ou moins 600 commandes), c'est \emph{Plain\index{tex@\TeX!Plain} \TeX}. Celui-ci facilite la création des documents. + +Le format le plus utilisé est \LaTeX\index{tex@\TeX!\LaTeX} (Leslie Lamport\index{Lamport Leslie}, 1985), qui offre des commandes et des structures plus générales pour certains documents (article, book,\dots) permettant un travail plus facile et plus rapide, mais parfois avec moins de flexibilité à cause du cadre plus ou moins rigide. D'autres formats sont \AmS-\TeX\index{tex@\TeX!\AmS-\TeX}, \AmS-\LaTeX, ConTeXt\index{tex@\TeX!ConTeXt}, chacun ayant des buts et des avantages (et inconvénients) particuliers. + +Pour étendre le format, on charge des \og modules\fg{} qui sont des collections de macros spécifiques à certains aspects de la typographie. + +Depuis sa définition, fin des années 70, jusqu'à maintenant, dernière version en mars 2008, la famille \TeX{} a dû évoluer pour tenir compte des développements de la typographie en dehors du monde \TeX. + +Quelques uns des problèmes étaient/sont: +\begin{itemize} +\item prendre en compte d'autres langues avec des \og alphabets\fg{} plus étendus que l'ASCII\footnote{``American Standard Code for Information Interchange'': système d'encodage des caractères incluant seulment les caractères Latin trouvés en anglais, quelques caractères communs de ponctuation et quelques autres symboles tels que \% ou \$} ou tout aussi bien avec des alphabets non latins, +\item avoir plus de polices, il n'y a pas grande variété dans les polices créées avec \textsf{METAFONT} (peu de créateurs l'utilisent), +\item créer des documents dans d'autres formats que le DVI d'origine \footnote{Device Independent: format des fichiers produits par \TeX{} et indépendants du système.}, +\item utiliser les riches possibilités des autres systèmes et formats typographiques comme PostScript et PDF, +\item avoir plus de facilités de calcul et de création de scripts,\dots +\end{itemize} + +Pour répondre à ces demandes et d'autres, de nombreux \og moteurs\fg{} et programmes ont été créés autour de \TeX, par exemple: pdftex\index{tex@\TeX!pdftex}, pdflatex, dvips\index{tex@\TeX!dvips}, ps2pdf, \textsf{METAPOST}\index{metapost@\textsf{METAPOST}} pour ouvrir le monde \TeX{} aux possibilités de PostScript\index{PostScript} et PDF\index{PDF}, XeTeX\index{tex@\TeX!XeTeX} et XeLaTeX pour pouvoir utiliser des fontes \og normales\fg{} sur les différentes machines et pour être capable de gérer les systèmes d'écriture différents des systèmes gauche-droite originaires d'Europe (lettres latines et cyrilliques et associés) -- droite-gauche, vertical, pictogrammes,\dots --, LuaTeX\index{tex@\TeX!LuaTeX} et LuaLaTeX pour avoir un langage puissant de scripts. + +Mais pour utiliser \TeX{} et les systèmes de sa famille, on doit créer un document \og source\fg{}\index{document!source} car \TeX{} n'est qu'un système pour transformer un document source en un document (parfaitement!) mis en page. Cette source est un simple fichier texte avec des instructions de mise en forme typographique et on a besoin d'un programme pour la créer: \textbf{l'éditeur\index{editeur@éditeur}}. + +Il y a beaucoup d'éditeurs capables de créer une source \TeX, certains sont des éditeurs généraux, d'autres sont spécifiquement créés pour \TeX: c'est ici qu'intervient \Tw\index{texworks@\Tw}. +\bigskip + +\Tw{} est un projet de création d'un éditeur de texte utilisé pour les outils de la faille \TeX, nous nous référerons à ceux-ci comme \AllTeX. Plutôt que de créer une nouvelle incarnation d'éditeur sophistiqué, bardé de multiples barres d'outils pour subvenir à tous les besoins, \Tw{} cherche au contraire à proposer un éditeur dépouillé, n'offrant, à première vue que des outils limités à l'édition de texte ainsi qu'un bouton et un menu déroulant pour composer un texte en \AllTeX. + +L'idée de création de l'éditeur fait suite à une longue réflexion de \emph{Jonathan Kew\index{Kew Jonathan}}, initiateur en charge du projet, sur les raisons qui éloignent les utilisateurs potentiels de \AllTeX, ainsi que de l'observation du succès de l'éditeur \textbf{\TeX shop\index{texshop@\TeX shop}} sous environnement Mac. + +Enfin, le but est aussi de fournir un éditeur identique sur de nombreuses plates-formes logicielles; \Tw{} est actuellement disponible sous Linux, sous macOS ainsi que sous Windows. Dans tous les cas l'interface se présente sous la même forme et offre les mêmes fonctionnalités. +%\bigskip + +Après l'introduction, la deuxième section explique comment installer le logiciel. Dans le troisième on décrit l'interface et on crée un premier document montrant les bases d'utilisation de \Tw. Dans les quatrièmes et cinquièmes sections on aborde les outils de travail avancés proposés par \Tw{}; cette section n'est à lire que lorsqu'on a bien en main les bases du travail sous \Tw{}. Les outils avancés permettent d'être beaucoup plus efficace. La sixième section donne une brève introduction à l'écriture de scripts (ce qui dépasse le but de ce manuel, on trouvera des informations ailleurs.) Enfin la septième section fournit des pointeurs vers des informations complémentaires sur \TeX{} et des sources d'aide; ceci termine la partie principale du document. + +Enfin, les annexes fournissent des informations pour \og customiser\fg{} l'éditeur \Tw, sur les expressions régulières pour le système rechercher/remplacer et comment \Tw{} peut être compilé à partir des sources. Une courte bibliographie et un index terminent ce manuel. + +\section{Icônes et style} + +Parce qu'une image vaut souvent mieux que mille mots, des icônes et des styles particuliers sont utilisés dans tout le manuel pour éviter des paragraphes incommodes ou marquer certains points spéciaux. Les touches du clavier sont généralement représentées par\keystroke{A}, à l'exception de quelques touches spéciales. Ce sont:\keysequence{Shift},\keysequence{PgUp},\keysequence{PgDown},\keysequence{Return} (retour charriot),\keysequence{UArrow},\keysequence{DArrow},\keysequence{LArrow},\keysequence{RArrow},\keysequence{Spacebar} (espace),\keysequence{BSpace} (backspace) et \keysequence{Tab} (tab). + +De plus, les cliques de souris sont représentés par {\LMB} (clique gauche) et {\RMB} (clique droit; sur macOS avec une souris à un bouton, cela est généralement réalisé en maintenant la touche {\Ctrl} tout en cliquant.) + +En dehors des instructions de saisie, de nombreux passages de ce manuel sont marqués avec un style particulier. + +\needspace{5\baselineskip} +Des informations valables seulement pour ou qui ne concernent qu'un système d'exploitation sont indiquées comme ceci: +\begin{OSWindows} +\noindent Ceci ne vous concerne que si vous utilisez Windows. \\ +Vous pouvez bien évidemment lire ces informations si vous utilisez un autre système d'exploitation. \\ +Ce ne sera que de peu d'usage pour vous. +\end{OSWindows} + +\bigskip +Les exemples de code sont donnés par une police de chasse fixe, style machine à écrire, avec des lignes au-dessus et en-dessous pour les séparer du reste du texte: +\begin{verbExample} +Hello \TeX-World! +\end{verbExample} + En relation directe avec ceci, le chapitre \ref{chap:first-steps} contient plusieurs tutoriels, présentés comme les exemples de code ci-dessus, mais avec une icône de bloc-note à côté. \ No newline at end of file diff -Nru texworks-manual-20200329/src/fr/outilsdedition.tex texworks-manual-20210308/src/fr/outilsdedition.tex --- texworks-manual-20200329/src/fr/outilsdedition.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/outilsdedition.tex 2021-03-08 17:33:22.000000000 +0100 @@ -1,199 +1,199 @@ -% !TEX encoding = UTF8 -% !TEX root = manuel.tex -% !TEX spellchack = fr_FR - -\chapter{Aller plus loin: outils d'{\'e}dition} - -Lorsque vous aurez \Tw{} bien en main, vous sentirez le besoin d'avoir des outils pour être plus efficace. Beaucoup d'outils existent dans \Tw{}. Nous les passons maintenant en revue. - -\section{Créer un document à partir d'un modèle}\index{modèle} - -Les documents que vous créerez ont le plus souvent les mêmes instructions dans le préambule, on charge les mêmes modules, on définit les mêmes caractéristiques de page, on définit aussi des en-tête et pied de page personnalisés. On peut utiliser les modèles prédéfinis ou créer ses propres modèles contenant tous ces pré-requis. - -Utilisez \menu{Fichier}\submenu\menu{Nouveau à partir d'un modèle\dots} ou \keysequence{Ctrl+Maj+N} (Mac OS X: \keysequence{Cmd+Maj+N}). Une boîte de dialogue s'ouvre pour permettre la sélection du modèle. Après sélection et \verb|OK| un document est créé et on peut commencer à travailler. - -Si on désire créer un modèle plus personnalisé, il suffit de créer ce document avec tout ce que l'on désire toujours y trouver (et en marquant éventuellement des emplacements à compléter) et de l'enregistrer comme fichier \path{.tex} dans le répertoire ressources de \Tw{} \path{<ressources>\templates} ou un sous-répertoire éventuel de celui-ci, si vous le désirez. - -\section{Créer un projet sur plusieurs fichiers sources}\index{projet} - -Lorsque la source d'un document devient longue, il est parfois difficile de se déplacer dans celle-ci et de la gérer. On a alors avantage à scinder le fichier source en plusieurs fichiers plus petits: un fichier sera le document principal, central, qui contiendra le préambule, l'environnement \verb|document|, ainsi que des appels aux \og sous-documents\fg \footnote{Appels par les commandes \verb|\input{}| ou \verb|\include{}|, voir les manuels de \LaTeX\ pour plus d'informations.}, qui pourraient contenir des chapitres séparés. - -Mais il y aura un problème si, étant dans un sous-document, on lance la composition/compilation; comme il n'y a pas de préambule ni d'environnement \verb|document| \LaTeX s'arrête immédiatement sur erreur. - -Pour signaler à \Tw{} qu'il doit compiler le document principal on ajoute au début du fichier sous-document l'instruction: \index{\verb+% "!TeX+!\verb+root+} - -\begin{verbExample} -% !TeX root = chemin/fichier_principal.tex -\end{verbExample} -par exemple: -\begin{verbExample} -% !TeX root = manuel.tex -\end{verbExample} -% -%\newcommand{\instex}{\texttt{\% !TeX}} -%\verb|% !TeX root = chemin/au/fichier_principal.tex|\index{instruction \instex!root} -% -%\noindent par exemple: -% -%\verb|% !TeX root = manuel.tex| - -Si le fichier principal est dans le même dossier, son nom suffit, comme dans l'exem\-ple ci-dessus. Sinon vous devez fournir le chemin vers le document principal (de préférence relativement au sous-document en question, p.e. \path{../manuel.tex}). Remarquer aussi l'utilisation des barres obliques \og\verb|/|\fg{} et non des contre-obliques \og\verb|\|\fg{} utilisées par Windows pour séparer les niveaux de dossiers. - -De plus, avec MikTeX, l'appel au sous-document, \verb|\input{nom.tex}|, doit inclure l'extension \path{.tex} pour que SyncTeX fonctionne convenablement (voir la section~\ref{sec.synctex}). - -\section{Vérification d'orthographe} - -On peut demander de faire une vérification orthographique \index{verif. orthographe@vérif. automatique}automatique durant la frappe par \menu{Édition}\submenu\menu{Vérification orthographique}\submenu\menu{<choix de langue>}: par exemple fr-FR pour le français. Il est également possible de demander à \Tw{} de permettre une vérification orthographique par défaut par \menu{Édition}\submenu\menu{Préférences\dots}\submenu\menu{Éditeur}\submenu\menu{Langue de vérification orthographique:}. - -Lors de la frappe, s'il y a une erreur pour le correcteur, le mot est souligné par un liséré rouge. Un clic-droit sur le mot ouvre un menu contextuel dans lequel il y a des propositions de mots de remplacement. Cliquer sur le mot désiré pour effectuer le remplacement. - -Avant d'utiliser la vérification orthographique, il faut installer des dictionnaires\index{dictionnaires} dans le bon dossier de \Tw: \path{<ressources>\dictionaries}. Le dossier \path{<ressources>} est atteint facilement par \menu{Aide}\submenu\menu{Paramètres et ressources\dots} - -\begin{OSLinux} -Sous Linux, les dictionnaires sont généralement pris dans le dossier \path{/usr/share/myspell/dicts} -- le chemin par défaut pour les dictionnaires de myspell. Notez, cependant, que la personne qui gère votre module \Tw{} a pu changer cela pour tenir compte de l'organisation du système de fichiers de votre distribution Linux. Vous pouvez passer outre à cet organisation par défaut en définissant la variable d'environnement \verb+TW_DICPATH+ avant d'exécuter Tw. -\end{OSLinux} - -On peut utiliser les dictionnaires disponibles pour OpenOffice.org et d'autres logiciels libres \footnote{voir par exemple à \url{http://extensions.services.openoffice.org/dictionary}. Les fichiers \path{.oxt} peuvent être renommés en \path{.zip} et ensuite décompressés pour trouver les fichiers nécessaires \path{.dic} et \path{.aff}.}; si par exemple vous avez Mozilla Thunderbird avec correction orthographique, vous pouvez copier les fichiers \path{.aff}\index{verif. orthographe@vérif. automatique!fichiers .aff} et \path{.dic}\index{verif. orthographe@vérif. automatique!fichiers .dic}. - -\section{Rechercher et remplacer} -\index{edition@édition!rechercher/remplacer}\index{rechercher/remplacer|see {édition}} - -%Autres outils classiques: la recherche et le remplacement de texte. \Tw{} dispose évidemment de ces possibilités avec quelques possibilités supplémentaires. - -\subsection{Les actions classiques} - -Les options du menu \menu{Recherche}--\menu{Rechercher\dots}, \menu{Chercher encore}, \menu{Remplacer\dots}, \menu{Remplacer encore} et \menu{Aller à la ligne\dots} (\keysequence{Ctrl+F}, \keysequence{Ctrl+G}, \keysequence{Ctrl+R}, \keysequence{Ctrl+Maj+R} et \keysequence{Ctrl+L} respectivement (Mac OS X: \keysequence{Cmd+F}, \keysequence{Cmd+G}, \keysequence{Cmd+R}, \keysequence{Cmd+Shift+R} et \keysequence{Cmd+L}) sont des actions classiques; la première et la troisième provoque l'ouverture d'une boîte de dialogue: - -\begin{center} -\includegraphics[scale=.6]{rechremp} -\end{center} - -On y trouve les options habituelles: \emph{Recherche en boucle -- dans tout le document}\emph{Chercher vers le haut}, \emph{Chercher/Remplacer dans la sélection} ou \emph{Chercher toutes les occurences}. Sont aussi classiques les options \emph{Sensible à la casse} et \emph{Mots entiers}. Par défaut la recherche se fait vers le bas, la fin du texte. - -L'option \emph{Remplacer dans tous les fichiers ouverts} est une extension fréquente, mais pas aussi répandue que les autres; cela permet de faire, par exemple, des remplacements dans tous les fichiers d'un projet -- faites attention que ceci est très puissant. - -La dernière option, \emph{Expression régulière}, est expliquée ci-après. - -Dans le menu \menu{Recherche} il y a d'autres options: -\begin{description} -\item[Copier vers Rechercher] copie le texte sélectionné et l'envoye dans la zone de saisie \textsl{\textbf{Rechercher:}} de la boîte de dialogue Rechercher ou Remplacer; vous devez encore ouvrir les dialogues séparément; -\item[Copier vers Remplacer] on peut faire de même avec un texte de remplacement vers la zone \textsl{\textbf{Par:}} de la boîte de dialogue \textsl{\textbf{Remplacer}}; -\item[Trouver la sélection] utilise la sélection pour une recherche sans ouvrir la boîte de dialogue \textsl{\textbf{Recherche}} -- très rapide; -\item[Montrer la sélection], nous ramène immédiatement au texte sélectionné -- pratique si on a sélectionné un texte et qu'on s'est déplacé dans le document par la glissière latérale, pratique aussi si on ne fait pas passer les lignes à la ligne. -\end{description} - -\subsection{Recherche/Remplacement avancé (les expressions régulières)}\index{expressions régulières} - -Les expressions régulières forment un outil très performant, mais qu'il convient de bien comprendre. Il faudrait un manuel uniquement pour cet apprentissage \footnote{De tels manuels existent sur internet.}, mais nous allons donner quelques idées d'utilisation. Voir aussi les expressions disponibles dans la section \ref{sec:regexp}. - -Supposons que nous ayons le texte suivant: -\begin{verbExample} -Voici du texte pour tester les expressions régulières -dans du texte accentué. -Voici du texte pour tester les expressions régulières dans -du texte accentué. -Voici du texte pour tester les expressions régulières. Voici -du texte pour tester les expressions régulières. -truc truc -tél.: 010-99-99-99 -tél.: 00.32.10.99.99.99 -tél.: 00/32-10/99.99.99 -\end{verbExample} -Nous désirons d'une part -\begin{enumerate} -\item séparer les différents paragraphes par une ligne vide après \og accentué\fg{} (pour créer des paragraphes dans \LaTeX) mais pas pour les trois numéros de téléphone; -\item remplacer les deux caractères tabulations (\textsl{tab})qui séparent les deux mots \og truc\fg{} du quatrième paragraphe chacun par trois espaces et, enfin; -\item uniformiser les numéros de téléphones en remplaçant les divers caractères de ponctuation par des espaces. -\end{enumerate} - -Pour 1) dans la boîte de dialogue \textsl{\textbf{Remplacer}} (\keysequence{Ctrl+R}) pour \emph{Rechercher:} on mettra {\frq\verb+\n+\flq} \footnote{les {\frq\flq} servent ici à montrer les limites des chaînes entrées et ne doivent pas être eux-mêmes entrés.} et dans \emph{Par:} {\frq\verb+\n\n+\flq}. {\frq\verb+\n+\flq} est le code pour le passage à la ligne. On prendra soin d'avoir sélectionné les quatre premiers paragraphes et le début du cinquième (premier numéro de téléphone) et de cocher les cases \emph{Remplacer dans la sélection} et \emph{Expression régulière}; si on ne l'a pas fait et qu'une ligne vide a été insérée entre toutes les lignes, sélectionner les lignes de téléphone et faire l'opération inverse: replacer {\frq\verb+\n\n+\flq} par {\frq\verb+\n+\flq}. Donc nous avons remplacer un passage à la ligne par un double, en créant ainsi une ligne vide. - -Pour 2) on utilisera {\frq\verb+\t+\flq} et {\frq\verb*+ +\flq}\footnote{Il s'agit de trois espaces.}. {\frq\verb+\t+\flq} est le code représentant une tabulation, un espace est entré tel quel (ici représenté par \verb*| |). - -Pour 3) ce sera: rechercher {\frq\verb+-|\.|/+\flq} et remplacer par {\frq\verb*+ +\flq}. Ici, {\frq\verb+|+\flq} fournit les diverses alternatives (\verb|-|, \verb|.|, or \verb|/|); pour le point nous avons utilisé {\frq\verb+\.+\flq} car le point seul est un code d'expression régulière qui représente n'importe quel caractère et nous aurions donc remplacer tous les caractères par un espace!! Nous devons dès lors utiliser un code pour avoir le point -- en mettant une contre-oblique devant le point, on précise que le point doit garder son sens propre plutôt que le sens spécial qu'il a généralement dans les expressinos régulières. - -Si on a des chaînes d'un même caractère mais de longueurs différentes (exemple 3, 4, 5 fois le caractère e) et qu'on veut tout ramener à une chaîne plus courte (exemple 2), on peut demander de remplacer la chaîne {\frq\verb+e{3,5}+\flq} par {\frq\verb+ee+\flq}. - -Si on veut insérer devant une série de paragraphes séparés ou non par une ligne vide une même chaîne, par exemple {\frq\verb*+\noindent +\flq} ou {\frq\verb*+\item +\flq}, on peut remplacer {\frq\verb+\n\n+\flq} ou {\frq\verb+\n+\flq} par {\frq\verb*+\n\n\\noindent +\flq} ou {\frq\verb*+\n\\noindent +\flq}. Attention, on a doublé le \verb|\| devant \verb|noindent| pour en avoir un (\verb|\noindent|), parce que \verb|\| est un caractère d'échapement dans les expressions régulièrs (nous l'avons rencontré auparavant dans l'expression \verb|\.|)! - -Si cela avait un sens, nous pourrions remplacer toutes les lettres comprises entre \og a\fg{} et \og m\fg{} par \og \$\fg{} en utilisant {\frq\verb+[a-m]+\flq} et {\frq\verb+$+\flq}. - -\section{Autres outils d'édition et de recherche d'erreur} -\index{edition@édition!outils} - -\subsection{Outils standard} - -Il est toujours possible d'annuler\index{edition@édition!annuler} une action non-désirée par \menu{Édition}\submenu\menu{Annuler} ou \keysequence{Ctrl+Z} (Mac OS X: \keysequence{Cmd+Z}); on peut ainsi annuler à reculons! L'opération inverse, annuler l'annulation ou refaire\index{edition@édition!refaire}, s'obtient par \menu{Édition}\submenu\menu{Répéter/refaire} ou \keysequence{Ctrl+Maj+Z} (Mac OS X \keysequence{Cmd+Maj+Z}.) \footnote{\keysequence{Ctrl+Y} et \keysequence{Alt+Maj+Backspace} fonctionnent aussi sous Windows. \keysequence{Cmd+Y} fonctionne aussi sur Mac OS X.} - -\Tw{} dispose aussi des outils classiques d'édition comme le presse papier; on peut donc sélectionner, couper/copier puis coller une partie de texte. - -On peut sélectionner à la souris en \og glissant\fg{} sur le texte à sélectionner, et on peut aussi \og double cliquer\fg{} pour sélectionner un mot. Au clavier il suffit de se déplacer en maintenant la touche \keysequence{Maj} enfoncée; on utilisera les touches de direction seules avec \keysequence{Maj} ; mais on peut aussi se déplacer et sélectionner par mot en se déplaçant à gauche ou à droite en maintenant \keysequence{Ctrl+Maj} enfoncés (\keysequence{Cmd+Shift} sous Mac OS X). Les raccourcis clavier du presse papier sont les raccourcis que l'on trouve dans pratiquement tous les logiciels: \keysequence{Ctrl-X} pour couper, \keysequence{Ctrl+C} pour copier et \keysequence{Ctrl+V} pour coller (\keysequence{Cmd+X}, \keysequence{Cmd+C} et \keysequence{Cmd+V} respectivement, Mac OS X.) - -On peut facilement changer la casse\index{edition@édition!changer la casse} d'une sélection -- tout mettre en capitales ou tout en minuscules -- par \menu{Édition}\submenu\menu{Changer la casse} puis, suivant le cas, \menu{TOUT EN CAPITALES} ou \menu{tout en minuscules}, ou \menu{Inverser la casse} (qui bascule la casse de chaque lettre idividuellement.) - -Il est aussi pratique de voir les numéros de lignes\index{edition@édition!numéros de lignes}, car tous les messages d'erreurs font référence à ces numéros; vous pouvez basculer \texttt{on/off} l'affichage des lignes, sur la gauche du panneau de saisie, par \menu{Format}\submenu\menu{Numéros de ligne}. - -\subsection{Commenter} - -Quand on met au point un texte pour \AllTeX{} il est souvent intéressant d'empêcher la compilation d'une partie du texte pour arriver à localiser les erreurs; on progresse ainsi morceau de texte par morceau de texte qui fonctionne jusqu'à rencontrer un fragment qui cause une erreur. Pour cela on commentera la source par bloc. - -Nous avons vu que le signe \verb|%| indique le début d'un commentaire. Pour commenter \index{edition@édition!commenter}une grande partie de texte, il suffit de la sélectionner puis de demander le marquage en tant que commentaire \menu{Format}\submenu\menu{Commenter} ou \keysequence{Ctrl+(} (Mac OS X: \keysequence{Cmd+Shift+]}.) Pour supprimer la mise en commentaire: sélectionnez les lignes et choisissez \menu{Format}\submenu\menu{Dé-commenter}\index{edition@édition!dé-commenter} ou \keysequence{Ctrl+)} (Mac OS X: \keysequence{Cmd+Maj+[} \footnote{Sur certains claviers, comme les claviers français,il n'est pas possible de faire \keysequence{Ctrl+Maj+[} ou \keysequence{Ctrl+Maj+]}; cependant les raccourcis peuvent être changés -- voir la section \ref{sec.shortcuts}.}. - -\subsection{Équilibrer les délimiteurs} -\index{edition@édition!équilibrer les délimiteurs} - -Une erreur fréquente est d'oublier un symbole fermant: parenthèse, accolade, crochet,\emph{etc}. \Tw{} propose un outil pour mettre en évidence les paires de symboles: lorsqu'on passe sur un de ces symboles son complémentaire est brièvement mis en sur-brillance orange. On peut également, quand on est à l'intérieur d'un bloc ainsi délimité demander de le sélectionner par \menu{Édition}\submenu\menu{Sélection d'un bloc entre délimiteurs}\index{edition@édition!sélection d'un bloc} ou son raccourci \keysequence{Ctrl+B} (Mac OS X: \keysequence{Cmd+B}). On voit ainsi directement l'ampleur du bloc. - -\subsection{Guillemets intelligents} -\index{edition@édition!guillemets intelligents} - -Une autre erreur similaire, mais ici sémantique et n'ayant aucune influence sur la composition, est rencontrée dans l'utilisation des guillemets lorsqu'on désire mettre un texte en évidence. - -En français il y a des guillemets `simples' et des guillemets \og{}doubles\fg. On utilise également les guillemets ``anglais'' pour un texte entre guillemets dans un texte déjà entre guillemets. Les guillemets simples et doubles anglais sont obtenus par \verb|`| et \verb|'|; ce ne sont pas les guillemets utilisés en programmation et trouvés sur la clavier \verb|"| et \verb|'|. Mais utilisant le système des guillemets intelligents de \Tw, on peut utiliser ces derniers pour produire automatiquement les guillemets simple/double ouvrants et fermants. - -Dans un document \path{.tex}, sélectionnez un des systèmes de guillemets intelligents: \menu{Format}\submenu\menu{Guillemets intelligents}\submenu\menu{Ligatures TeX}, \submenu\menu{Com\-mandes TeX}, \submenu\menu{Caractères Unicode} \footnote{par défaut, il n'y a que les systèmes pour les guillemets à l'anglaise, mais on peut définir c'est propres quillemets}. Ensuite dans votre texte, lorsque vous voulez commencer un texte mis en évidence, disons des guillemets doubles, entrez \verb|"| puis le texte et pour terminer de nouveau \verb|"|; \Tw{} va automatiquement insérer les guillemets ouvrants \verb|``| et ensuite les guillemets fermants corrects \verb|''|. Les trois options donnent le même résultat dans le document composé, mais \menu{Ligatures TeX} devrait bien fonctionner dans la plupart des cas. - -Enfin, il est possible de définir ses propres systèmes de guillemets (dans le fichier de définitions (\path{smart-quotes-modes.txt} dans le dossier \path{configuration} du dossier ressources.) Par exemple, pour les guillemets français de babel, ajoutez le code suivant: -\begin{verbExample} -#[French quotes] -[Guillemets français] -' ` ' -" \og{} \fg{} -\end{verbExample} - -\section{La complétion automatique}\index{complétion automatique} - -Un autre outil dont on ne peut rapidement plus se passer est la complétion automatique. En effet, quand on utilise \AllTeX, on doit continuellement entrer des codes pour, par exemple, créer des environnements; de plus dans ce cas il ne faut pas oublier de les fermer. - -La complétion automatique permet de taper une suite de caractères, on pourrait dire un mot clé, puis en tapant \keysequence{Tab} \Tw{} crée automatiquement le code de la commande ou de l'environnement \AllTeX. - -Par exemple, pour obtenir \og\LaTeX\fg, il faut entrer \verb|\LaTeX|. Ce n'est pas difficile, mais l'introduction du ``\verb|\|'' \footnote{en particulier sur clavier Azerty, où $\backslash$ nécessite l'utilisation de \keysequence{AltGr+<} ou \keysequence{Ctrl+Alt+<}} puis du mot ``\verb|LaTeX|'' avec l'alternance de majuscules et de minuscules peut devenir fastidieux à la longue. Par la complétion automatique il suffit d'entrer \verb|latex| puis taper \keysequence{TaB} pour obtenir \verb|\LaTeX|. Il faut juste veiller à ne pas avoir une \emph{lettre} accolée devant ou derrière \verb|latex| -- par ex. \verb|alatax| -- sinon le mécanisme pourrait ne pas choisir le mot clé correct. - -\needspace{3\baselineskip} -Autres exemples, \verb|bmin| produit: -\begin{verbExample} -\begin{minipage}{} -• -\end{minipage}• -\end{verbExample} -le curseur de saisie se trouve dans la paire d'accolades vide où il faut entrer la dimension de la minipage. Voir la section \ref{sec.autocompletion} pourune liste des mots clé d'autocomplétion. -%, et \verb|xve| donne \verb|\varepsilon| soit $\varepsilon$ en mode mathématiques. Voir la section \ref{autoc} pour une liste des mots clé d'auto-complétion. -Remarquons le \og•\fg{} dans l'environnement minipage. C'est une marque que l'on peut atteindre par \keysequence{Ctrl+Tab} (\keysequence{Option+Tab} sur le Mac), en répétant ce raccourci, on avance dans la structure créée et par \keysequence{Ctrl+Maj+Tab} (\keysequence{Option+Shift+Tab}) on recule. - -Il est à remarquer que si on donne un mot clé partiel et que l'on appuie successivement sur \keysequence{Tab}, on peut avoir d'autres complétions, généralement associées. Par exemple, \verb|bali| (le \verb|b| indique un début d'environnement \verb|\begin{}|) crée l'environnement \verb|align| après un \keysequence{Tab}, \verb|align*| ensuite, successivement \verb|alignat|, \verb|alignat*|, \verb|aligned|, \verb|alignedat|, \verb|alignedat| avec option; ces derniers environnements ont leur propre code qui commence par \verb|bali| (\verb|balis|, \verb|baliat|, \verb|baliats|, \verb|balied|, \verb|baliedat| et enfin \verb|baliedato|.) - -Enfin, si vous désirer créer vos propres raccourcis, vous pouvez toujours ajouter un fichier \path{.txt} dans le sous-répertoire \path{completion} du répertoire ressources. -Les entrées dans ce fichier seront de la forme: -\begin{verbExample} -bfigo:=\begin{figure}[#INS#]#RET##RET#\end{figure}• -\bibliography{#INS#}• -\end{verbExample} - -Dans le premier cas, pour l'environnement \verb|figure| avec option, \verb|bfigo| est le mot clé, puis vient l'affectation \verb|:=| et la définition: écrire \verb|\begin{figure}[]| \verb|\end{figure}| avec un passage à la ligne après le \verb|begin| (\verb|#RET#|), laisser une ligne vide (deuxième \verb|#RET#|) et mettre le curseur d'insertion entre les crochets (\verb|#INS#|); \og•\fg{} est la marque de déplacement expliquée plus haut. - -Dans le deuxième cas il n'y aura que \verb|\bibliography{}| lui-même et \Tw{} créera le nom complet avec accolades (le curseur entre elles.) Dans ce cas le mot clé est l'instruction elle-même. - -%Il est évidemment possible d'utiliser le \og•\fg! - -Il faut veiller à créer des fichiers \path{.txt} encodés en utf-8; on peut pour cela utiliser le programme \Tw{} lui-même, qui utilise cet encodage par défaut. - +% !TEX encoding = UTF8 +% !TEX root = manuel.tex +% !TEX spellchack = fr_FR + +\chapter{Aller plus loin: outils d'{\'e}dition} + +Lorsque vous aurez \Tw{} bien en main, vous sentirez le besoin d'avoir des outils pour être plus efficace. Beaucoup d'outils existent dans \Tw{}. Nous les passons maintenant en revue. + +\section{Créer un document à partir d'un modèle}\index{modèle} + +Les documents que vous créerez ont le plus souvent les mêmes instructions dans le préambule, on charge les mêmes modules, on définit les mêmes caractéristiques de page, on définit aussi des en-tête et pied de page personnalisés. On peut utiliser les modèles prédéfinis ou créer ses propres modèles contenant tous ces pré-requis. + +Utilisez \menu{Fichier}\submenu\menu{Nouveau à partir d'un modèle\dots} ou \keysequence{Ctrl+Maj+N} (macOS: \keysequence{Cmd+Maj+N}). Une boîte de dialogue s'ouvre pour permettre la sélection du modèle. Après sélection et \verb|OK| un document est créé et on peut commencer à travailler. + +Si on désire créer un modèle plus personnalisé, il suffit de créer ce document avec tout ce que l'on désire toujours y trouver (et en marquant éventuellement des emplacements à compléter) et de l'enregistrer comme fichier \path{.tex} dans le répertoire ressources de \Tw{} \path{<ressources>\templates} ou un sous-répertoire éventuel de celui-ci, si vous le désirez. + +\section{Créer un projet sur plusieurs fichiers sources}\index{projet} + +Lorsque la source d'un document devient longue, il est parfois difficile de se déplacer dans celle-ci et de la gérer. On a alors avantage à scinder le fichier source en plusieurs fichiers plus petits: un fichier sera le document principal, central, qui contiendra le préambule, l'environnement \verb|document|, ainsi que des appels aux \og sous-documents\fg \footnote{Appels par les commandes \verb|\input{}| ou \verb|\include{}|, voir les manuels de \LaTeX\ pour plus d'informations.}, qui pourraient contenir des chapitres séparés. + +Mais il y aura un problème si, étant dans un sous-document, on lance la composition/compilation; comme il n'y a pas de préambule ni d'environnement \verb|document| \LaTeX s'arrête immédiatement sur erreur. + +Pour signaler à \Tw{} qu'il doit compiler le document principal on ajoute au début du fichier sous-document l'instruction: \index{\verb+% "!TeX+!\verb+root+} + +\begin{verbExample} +% !TeX root = chemin/fichier_principal.tex +\end{verbExample} +par exemple: +\begin{verbExample} +% !TeX root = manuel.tex +\end{verbExample} +% +%\newcommand{\instex}{\texttt{\% !TeX}} +%\verb|% !TeX root = chemin/au/fichier_principal.tex|\index{instruction \instex!root} +% +%\noindent par exemple: +% +%\verb|% !TeX root = manuel.tex| + +Si le fichier principal est dans le même dossier, son nom suffit, comme dans l'exem\-ple ci-dessus. Sinon vous devez fournir le chemin vers le document principal (de préférence relativement au sous-document en question, p.e. \path{../manuel.tex}). Remarquer aussi l'utilisation des barres obliques \og\verb|/|\fg{} et non des contre-obliques \og\verb|\|\fg{} utilisées par Windows pour séparer les niveaux de dossiers. + +De plus, avec MikTeX, l'appel au sous-document, \verb|\input{nom.tex}|, doit inclure l'extension \path{.tex} pour que SyncTeX fonctionne convenablement (voir la section~\ref{sec.synctex}). + +\section{Vérification d'orthographe} + +On peut demander de faire une vérification orthographique \index{verif. orthographe@vérif. automatique}automatique durant la frappe par \menu{Édition}\submenu\menu{Vérification orthographique}\submenu\menu{<choix de langue>}: par exemple fr-FR pour le français. Il est également possible de demander à \Tw{} de permettre une vérification orthographique par défaut par \menu{Édition}\submenu\menu{Préférences\dots}\submenu\menu{Éditeur}\submenu\menu{Langue de vérification orthographique:}. + +Lors de la frappe, s'il y a une erreur pour le correcteur, le mot est souligné par un liséré rouge. Un clic-droit sur le mot ouvre un menu contextuel dans lequel il y a des propositions de mots de remplacement. Cliquer sur le mot désiré pour effectuer le remplacement. + +Avant d'utiliser la vérification orthographique, il faut installer des dictionnaires\index{dictionnaires} dans le bon dossier de \Tw: \path{<ressources>\dictionaries}. Le dossier \path{<ressources>} est atteint facilement par \menu{Aide}\submenu\menu{Paramètres et ressources\dots} + +\begin{OSLinux} +Sous Linux, les dictionnaires sont généralement pris dans le dossier \path{/usr/share/myspell/dicts} -- le chemin par défaut pour les dictionnaires de myspell. Notez, cependant, que la personne qui gère votre module \Tw{} a pu changer cela pour tenir compte de l'organisation du système de fichiers de votre distribution Linux. Vous pouvez passer outre à cet organisation par défaut en définissant la variable d'environnement \verb+TW_DICPATH+ avant d'exécuter Tw. +\end{OSLinux} + +On peut utiliser les dictionnaires disponibles pour OpenOffice.org et d'autres logiciels libres \footnote{voir par exemple à \url{http://extensions.services.openoffice.org/dictionary}. Les fichiers \path{.oxt} peuvent être renommés en \path{.zip} et ensuite décompressés pour trouver les fichiers nécessaires \path{.dic} et \path{.aff}.}; si par exemple vous avez Mozilla Thunderbird avec correction orthographique, vous pouvez copier les fichiers \path{.aff}\index{verif. orthographe@vérif. automatique!fichiers .aff} et \path{.dic}\index{verif. orthographe@vérif. automatique!fichiers .dic}. + +\section{Rechercher et remplacer} +\index{edition@édition!rechercher/remplacer}\index{rechercher/remplacer|see {édition}} + +%Autres outils classiques: la recherche et le remplacement de texte. \Tw{} dispose évidemment de ces possibilités avec quelques possibilités supplémentaires. + +\subsection{Les actions classiques} + +Les options du menu \menu{Recherche}--\menu{Rechercher\dots}, \menu{Chercher encore}, \menu{Remplacer\dots}, \menu{Remplacer encore} et \menu{Aller à la ligne\dots} (\keysequence{Ctrl+F}, \keysequence{Ctrl+G}, \keysequence{Ctrl+R}, \keysequence{Ctrl+Maj+R} et \keysequence{Ctrl+L} respectivement (macOS: \keysequence{Cmd+F}, \keysequence{Cmd+G}, \keysequence{Cmd+R}, \keysequence{Cmd+Shift+R} et \keysequence{Cmd+L}) sont des actions classiques; la première et la troisième provoque l'ouverture d'une boîte de dialogue: + +\begin{center} +\includegraphics[scale=.6]{rechremp} +\end{center} + +On y trouve les options habituelles: \emph{Recherche en boucle -- dans tout le document}\emph{Chercher vers le haut}, \emph{Chercher/Remplacer dans la sélection} ou \emph{Chercher toutes les occurences}. Sont aussi classiques les options \emph{Sensible à la casse} et \emph{Mots entiers}. Par défaut la recherche se fait vers le bas, la fin du texte. + +L'option \emph{Remplacer dans tous les fichiers ouverts} est une extension fréquente, mais pas aussi répandue que les autres; cela permet de faire, par exemple, des remplacements dans tous les fichiers d'un projet -- faites attention que ceci est très puissant. + +La dernière option, \emph{Expression régulière}, est expliquée ci-après. + +Dans le menu \menu{Recherche} il y a d'autres options: +\begin{description} +\item[Copier vers Rechercher] copie le texte sélectionné et l'envoye dans la zone de saisie \textsl{\textbf{Rechercher:}} de la boîte de dialogue Rechercher ou Remplacer; vous devez encore ouvrir les dialogues séparément; +\item[Copier vers Remplacer] on peut faire de même avec un texte de remplacement vers la zone \textsl{\textbf{Par:}} de la boîte de dialogue \textsl{\textbf{Remplacer}}; +\item[Trouver la sélection] utilise la sélection pour une recherche sans ouvrir la boîte de dialogue \textsl{\textbf{Recherche}} -- très rapide; +\item[Montrer la sélection], nous ramène immédiatement au texte sélectionné -- pratique si on a sélectionné un texte et qu'on s'est déplacé dans le document par la glissière latérale, pratique aussi si on ne fait pas passer les lignes à la ligne. +\end{description} + +\subsection{Recherche/Remplacement avancé (les expressions régulières)}\index{expressions régulières} + +Les expressions régulières forment un outil très performant, mais qu'il convient de bien comprendre. Il faudrait un manuel uniquement pour cet apprentissage \footnote{De tels manuels existent sur internet.}, mais nous allons donner quelques idées d'utilisation. Voir aussi les expressions disponibles dans la section \ref{sec:regexp}. + +Supposons que nous ayons le texte suivant: +\begin{verbExample} +Voici du texte pour tester les expressions régulières +dans du texte accentué. +Voici du texte pour tester les expressions régulières dans +du texte accentué. +Voici du texte pour tester les expressions régulières. Voici +du texte pour tester les expressions régulières. +truc truc +tél.: 010-99-99-99 +tél.: 00.32.10.99.99.99 +tél.: 00/32-10/99.99.99 +\end{verbExample} +Nous désirons d'une part +\begin{enumerate} +\item séparer les différents paragraphes par une ligne vide après \og accentué\fg{} (pour créer des paragraphes dans \LaTeX) mais pas pour les trois numéros de téléphone; +\item remplacer les deux caractères tabulations (\textsl{tab})qui séparent les deux mots \og truc\fg{} du quatrième paragraphe chacun par trois espaces et, enfin; +\item uniformiser les numéros de téléphones en remplaçant les divers caractères de ponctuation par des espaces. +\end{enumerate} + +Pour 1) dans la boîte de dialogue \textsl{\textbf{Remplacer}} (\keysequence{Ctrl+R}) pour \emph{Rechercher:} on mettra {\frq\verb+\n+\flq} \footnote{les {\frq\flq} servent ici à montrer les limites des chaînes entrées et ne doivent pas être eux-mêmes entrés.} et dans \emph{Par:} {\frq\verb+\n\n+\flq}. {\frq\verb+\n+\flq} est le code pour le passage à la ligne. On prendra soin d'avoir sélectionné les quatre premiers paragraphes et le début du cinquième (premier numéro de téléphone) et de cocher les cases \emph{Remplacer dans la sélection} et \emph{Expression régulière}; si on ne l'a pas fait et qu'une ligne vide a été insérée entre toutes les lignes, sélectionner les lignes de téléphone et faire l'opération inverse: replacer {\frq\verb+\n\n+\flq} par {\frq\verb+\n+\flq}. Donc nous avons remplacer un passage à la ligne par un double, en créant ainsi une ligne vide. + +Pour 2) on utilisera {\frq\verb+\t+\flq} et {\frq\verb*+ +\flq}\footnote{Il s'agit de trois espaces.}. {\frq\verb+\t+\flq} est le code représentant une tabulation, un espace est entré tel quel (ici représenté par \verb*| |). + +Pour 3) ce sera: rechercher {\frq\verb+-|\.|/+\flq} et remplacer par {\frq\verb*+ +\flq}. Ici, {\frq\verb+|+\flq} fournit les diverses alternatives (\verb|-|, \verb|.|, or \verb|/|); pour le point nous avons utilisé {\frq\verb+\.+\flq} car le point seul est un code d'expression régulière qui représente n'importe quel caractère et nous aurions donc remplacer tous les caractères par un espace!! Nous devons dès lors utiliser un code pour avoir le point -- en mettant une contre-oblique devant le point, on précise que le point doit garder son sens propre plutôt que le sens spécial qu'il a généralement dans les expressinos régulières. + +Si on a des chaînes d'un même caractère mais de longueurs différentes (exemple 3, 4, 5 fois le caractère e) et qu'on veut tout ramener à une chaîne plus courte (exemple 2), on peut demander de remplacer la chaîne {\frq\verb+e{3,5}+\flq} par {\frq\verb+ee+\flq}. + +Si on veut insérer devant une série de paragraphes séparés ou non par une ligne vide une même chaîne, par exemple {\frq\verb*+\noindent +\flq} ou {\frq\verb*+\item +\flq}, on peut remplacer {\frq\verb+\n\n+\flq} ou {\frq\verb+\n+\flq} par {\frq\verb*+\n\n\\noindent +\flq} ou {\frq\verb*+\n\\noindent +\flq}. Attention, on a doublé le \verb|\| devant \verb|noindent| pour en avoir un (\verb|\noindent|), parce que \verb|\| est un caractère d'échapement dans les expressions régulièrs (nous l'avons rencontré auparavant dans l'expression \verb|\.|)! + +Si cela avait un sens, nous pourrions remplacer toutes les lettres comprises entre \og a\fg{} et \og m\fg{} par \og \$\fg{} en utilisant {\frq\verb+[a-m]+\flq} et {\frq\verb+$+\flq}. + +\section{Autres outils d'édition et de recherche d'erreur} +\index{edition@édition!outils} + +\subsection{Outils standard} + +Il est toujours possible d'annuler\index{edition@édition!annuler} une action non-désirée par \menu{Édition}\submenu\menu{Annuler} ou \keysequence{Ctrl+Z} (macOS: \keysequence{Cmd+Z}); on peut ainsi annuler à reculons! L'opération inverse, annuler l'annulation ou refaire\index{edition@édition!refaire}, s'obtient par \menu{Édition}\submenu\menu{Répéter/refaire} ou \keysequence{Ctrl+Maj+Z} (macOS \keysequence{Cmd+Maj+Z}.) \footnote{\keysequence{Ctrl+Y} et \keysequence{Alt+Maj+Backspace} fonctionnent aussi sous Windows. \keysequence{Cmd+Y} fonctionne aussi sur macOS.} + +\Tw{} dispose aussi des outils classiques d'édition comme le presse papier; on peut donc sélectionner, couper/copier puis coller une partie de texte. + +On peut sélectionner à la souris en \og glissant\fg{} sur le texte à sélectionner, et on peut aussi \og double cliquer\fg{} pour sélectionner un mot. Au clavier il suffit de se déplacer en maintenant la touche \keysequence{Maj} enfoncée; on utilisera les touches de direction seules avec \keysequence{Maj} ; mais on peut aussi se déplacer et sélectionner par mot en se déplaçant à gauche ou à droite en maintenant \keysequence{Ctrl+Maj} enfoncés (\keysequence{Cmd+Shift} sous macOS). Les raccourcis clavier du presse papier sont les raccourcis que l'on trouve dans pratiquement tous les logiciels: \keysequence{Ctrl-X} pour couper, \keysequence{Ctrl+C} pour copier et \keysequence{Ctrl+V} pour coller (\keysequence{Cmd+X}, \keysequence{Cmd+C} et \keysequence{Cmd+V} respectivement, macOS.) + +On peut facilement changer la casse\index{edition@édition!changer la casse} d'une sélection -- tout mettre en capitales ou tout en minuscules -- par \menu{Édition}\submenu\menu{Changer la casse} puis, suivant le cas, \menu{TOUT EN CAPITALES} ou \menu{tout en minuscules}, ou \menu{Inverser la casse} (qui bascule la casse de chaque lettre idividuellement.) + +Il est aussi pratique de voir les numéros de lignes\index{edition@édition!numéros de lignes}, car tous les messages d'erreurs font référence à ces numéros; vous pouvez basculer \texttt{on/off} l'affichage des lignes, sur la gauche du panneau de saisie, par \menu{Format}\submenu\menu{Numéros de ligne}. + +\subsection{Commenter} + +Quand on met au point un texte pour \AllTeX{} il est souvent intéressant d'empêcher la compilation d'une partie du texte pour arriver à localiser les erreurs; on progresse ainsi morceau de texte par morceau de texte qui fonctionne jusqu'à rencontrer un fragment qui cause une erreur. Pour cela on commentera la source par bloc. + +Nous avons vu que le signe \verb|%| indique le début d'un commentaire. Pour commenter \index{edition@édition!commenter}une grande partie de texte, il suffit de la sélectionner puis de demander le marquage en tant que commentaire \menu{Format}\submenu\menu{Commenter} ou \keysequence{Ctrl+(} (macOS: \keysequence{Cmd+Shift+]}.) Pour supprimer la mise en commentaire: sélectionnez les lignes et choisissez \menu{Format}\submenu\menu{Dé-commenter}\index{edition@édition!dé-commenter} ou \keysequence{Ctrl+)} (macOS: \keysequence{Cmd+Maj+[} \footnote{Sur certains claviers, comme les claviers français,il n'est pas possible de faire \keysequence{Ctrl+Maj+[} ou \keysequence{Ctrl+Maj+]}; cependant les raccourcis peuvent être changés -- voir la section \ref{sec.shortcuts}.}. + +\subsection{Équilibrer les délimiteurs} +\index{edition@édition!équilibrer les délimiteurs} + +Une erreur fréquente est d'oublier un symbole fermant: parenthèse, accolade, crochet,\emph{etc}. \Tw{} propose un outil pour mettre en évidence les paires de symboles: lorsqu'on passe sur un de ces symboles son complémentaire est brièvement mis en sur-brillance orange. On peut également, quand on est à l'intérieur d'un bloc ainsi délimité demander de le sélectionner par \menu{Édition}\submenu\menu{Sélection d'un bloc entre délimiteurs}\index{edition@édition!sélection d'un bloc} ou son raccourci \keysequence{Ctrl+B} (macOS: \keysequence{Cmd+B}). On voit ainsi directement l'ampleur du bloc. + +\subsection{Guillemets intelligents} +\index{edition@édition!guillemets intelligents} + +Une autre erreur similaire, mais ici sémantique et n'ayant aucune influence sur la composition, est rencontrée dans l'utilisation des guillemets lorsqu'on désire mettre un texte en évidence. + +En français il y a des guillemets `simples' et des guillemets \og{}doubles\fg. On utilise également les guillemets ``anglais'' pour un texte entre guillemets dans un texte déjà entre guillemets. Les guillemets simples et doubles anglais sont obtenus par \verb|`| et \verb|'|; ce ne sont pas les guillemets utilisés en programmation et trouvés sur la clavier \verb|"| et \verb|'|. Mais utilisant le système des guillemets intelligents de \Tw, on peut utiliser ces derniers pour produire automatiquement les guillemets simple/double ouvrants et fermants. + +Dans un document \path{.tex}, sélectionnez un des systèmes de guillemets intelligents: \menu{Format}\submenu\menu{Guillemets intelligents}\submenu\menu{Ligatures TeX}, \submenu\menu{Com\-mandes TeX}, \submenu\menu{Caractères Unicode} \footnote{par défaut, il n'y a que les systèmes pour les guillemets à l'anglaise, mais on peut définir c'est propres quillemets}. Ensuite dans votre texte, lorsque vous voulez commencer un texte mis en évidence, disons des guillemets doubles, entrez \verb|"| puis le texte et pour terminer de nouveau \verb|"|; \Tw{} va automatiquement insérer les guillemets ouvrants \verb|``| et ensuite les guillemets fermants corrects \verb|''|. Les trois options donnent le même résultat dans le document composé, mais \menu{Ligatures TeX} devrait bien fonctionner dans la plupart des cas. + +Enfin, il est possible de définir ses propres systèmes de guillemets (dans le fichier de définitions (\path{smart-quotes-modes.txt} dans le dossier \path{configuration} du dossier ressources.) Par exemple, pour les guillemets français de babel, ajoutez le code suivant: +\begin{verbExample} +#[French quotes] +[Guillemets français] +' ` ' +" \og{} \fg{} +\end{verbExample} + +\section{La complétion automatique}\index{complétion automatique} + +Un autre outil dont on ne peut rapidement plus se passer est la complétion automatique. En effet, quand on utilise \AllTeX, on doit continuellement entrer des codes pour, par exemple, créer des environnements; de plus dans ce cas il ne faut pas oublier de les fermer. + +La complétion automatique permet de taper une suite de caractères, on pourrait dire un mot clé, puis en tapant \keysequence{Tab} \Tw{} crée automatiquement le code de la commande ou de l'environnement \AllTeX. + +Par exemple, pour obtenir \og\LaTeX\fg, il faut entrer \verb|\LaTeX|. Ce n'est pas difficile, mais l'introduction du ``\verb|\|'' \footnote{en particulier sur clavier Azerty, où $\backslash$ nécessite l'utilisation de \keysequence{AltGr+<} ou \keysequence{Ctrl+Alt+<}} puis du mot ``\verb|LaTeX|'' avec l'alternance de majuscules et de minuscules peut devenir fastidieux à la longue. Par la complétion automatique il suffit d'entrer \verb|latex| puis taper \keysequence{TaB} pour obtenir \verb|\LaTeX|. Il faut juste veiller à ne pas avoir une \emph{lettre} accolée devant ou derrière \verb|latex| -- par ex. \verb|alatax| -- sinon le mécanisme pourrait ne pas choisir le mot clé correct. + +\needspace{3\baselineskip} +Autres exemples, \verb|bmin| produit: +\begin{verbExample} +\begin{minipage}{} +• +\end{minipage}• +\end{verbExample} +le curseur de saisie se trouve dans la paire d'accolades vide où il faut entrer la dimension de la minipage. Voir la section \ref{sec.autocompletion} pourune liste des mots clé d'autocomplétion. +%, et \verb|xve| donne \verb|\varepsilon| soit $\varepsilon$ en mode mathématiques. Voir la section \ref{autoc} pour une liste des mots clé d'auto-complétion. +Remarquons le \og•\fg{} dans l'environnement minipage. C'est une marque que l'on peut atteindre par \keysequence{Ctrl+Tab} (\keysequence{Option+Tab} sur le Mac), en répétant ce raccourci, on avance dans la structure créée et par \keysequence{Ctrl+Maj+Tab} (\keysequence{Option+Shift+Tab}) on recule. + +Il est à remarquer que si on donne un mot clé partiel et que l'on appuie successivement sur \keysequence{Tab}, on peut avoir d'autres complétions, généralement associées. Par exemple, \verb|bali| (le \verb|b| indique un début d'environnement \verb|\begin{}|) crée l'environnement \verb|align| après un \keysequence{Tab}, \verb|align*| ensuite, successivement \verb|alignat|, \verb|alignat*|, \verb|aligned|, \verb|alignedat|, \verb|alignedat| avec option; ces derniers environnements ont leur propre code qui commence par \verb|bali| (\verb|balis|, \verb|baliat|, \verb|baliats|, \verb|balied|, \verb|baliedat| et enfin \verb|baliedato|.) + +Enfin, si vous désirer créer vos propres raccourcis, vous pouvez toujours ajouter un fichier \path{.txt} dans le sous-répertoire \path{completion} du répertoire ressources. +Les entrées dans ce fichier seront de la forme: +\begin{verbExample} +bfigo:=\begin{figure}[#INS#]#RET##RET#\end{figure}• +\bibliography{#INS#}• +\end{verbExample} + +Dans le premier cas, pour l'environnement \verb|figure| avec option, \verb|bfigo| est le mot clé, puis vient l'affectation \verb|:=| et la définition: écrire \verb|\begin{figure}[]| \verb|\end{figure}| avec un passage à la ligne après le \verb|begin| (\verb|#RET#|), laisser une ligne vide (deuxième \verb|#RET#|) et mettre le curseur d'insertion entre les crochets (\verb|#INS#|); \og•\fg{} est la marque de déplacement expliquée plus haut. + +Dans le deuxième cas il n'y aura que \verb|\bibliography{}| lui-même et \Tw{} créera le nom complet avec accolades (le curseur entre elles.) Dans ce cas le mot clé est l'instruction elle-même. + +%Il est évidemment possible d'utiliser le \og•\fg! + +Il faut veiller à créer des fichiers \path{.txt} encodés en utf-8; on peut pour cela utiliser le programme \Tw{} lui-même, qui utilise cet encodage par défaut. + diff -Nru texworks-manual-20200329/src/fr/premierspas.tex texworks-manual-20210308/src/fr/premierspas.tex --- texworks-manual-20200329/src/fr/premierspas.tex 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/premierspas.tex 2021-03-08 17:33:22.000000000 +0100 @@ -1,199 +1,199 @@ -% !TEX encoding = UTF8 -% !TEX root = manuel.tex -% !TEX spellcheck = fr_FR - -\chapter{Prise en main} -\label{chap:first-steps} - -Voyons maintenant comment réaliser un premier document: pour cela on devra le saisir dans la fenêtre d'édition de \Tw{}. \AllTeX{} \emph{n'étant pas} des logiciels WYSIWYG\index{WYSIWYG} \footnote{\emph{What You See Is What You Get}, c'est-à-dire \og ce que vous voyez est ce que vous obtenez\fg.}, vous devrez taper le texte et les instructions de mise en forme et vous ne verrez le résultat qu'après avoir \og composé\fg{} le texte. Cela paraît austère, mais on s'y fait très vite et on est amplement récompensé par le résultat. - -\section{Description sommaire de l'interface}\index{interface} - -\newsavebox{\inlineimg} -\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar1}\hspace{1em}} - -Lorsqu'il s'ouvre l'éditeur présente une interface très dépouillée: une barre de titre, une barre de menu, deux petites barres d'outils\index{barre d'outils}, une grande zone (blanche) de saisie et, tout en bas, une barre d'état. Nous sommes dans la fenêtre \emph{source/éditeur}\index{source/éditeur}. Si vous avez déjà composé le document auparavant, le \path{.pdf} résultant sera affiché du côté droit dans la fenêtre de \emph{prévisualisation.}\index{prévisualisation} -\vspace{10pt} - -%\noindent\includegraphics[scale=.6]{barreun}\hspace{10pt} -\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar1}\hspace{.5em}} -\begin{wrapfigure}[2]{l}{90pt} -\vspace*{-1em} -\usebox{\inlineimg} -\end{wrapfigure} -\noindent La première barre d'outils a un bouton pour lancer la composition et une liste déroulante pour choisir le format de composition (nous prendrons \verb|pdfLaTeX|.) Sachant que le raccourci clavier de la composition est \keysequence{Ctrl+T} (Mac OS X: \keysequence{Cmd+T}) et que l'on ne change pratiquement jamais de format, on pourrait même ne pas afficher cette barre d'outils. De plus le choix peut se faire par le menu \menu{Composition}\index{composition}. -\vspace{10pt} - -%\noindent\includegraphics[scale=.6]{barredeux}\hspace{10pt} -\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar2}\hspace{.5em}} -%\begin{wrapfigure}[2]{l}{\widthof{\usebox{\inlineimg}}} -\begin{wrapfigure}[2]{l}{160pt} -\vspace*{-1em} -\usebox{\inlineimg} -\end{wrapfigure} -\noindent La deuxième n'offre que des boutons classiques: Nouveau document, Ouvrir, Sauvegarder | Annuler, Répéter | Couper, Copier, Coller | Rechercher, Remplacer. - -\begin{center} -\includegraphics[width=\textwidth]{interface-Tw} -%\setlength{\unitlength}{1mm}\begin{picture}(0,0) -%\put(-110,106.5){\colorbox{green}{\scriptsize Barre de titre}} -%\put(-100,103.5){\colorbox{green}{\scriptsize Menu}} -%\put(-92,101){\colorbox{green}{\scriptsize Barre d'outils}} -%\put(-118,56){\colorbox{green}{\small Zone d'édition}} -%\put(-42,56){\colorbox{green}{\small Prévisualisation}} -%\put(-115,1){\colorbox{green}{\scriptsize Barre de statut}} -%\end{picture}\setlength{\unitlength}{1pt} -\end{center} - -Même s'ils ne ressemblent pas à de vrais boutons, les zones de la barre de statut peuvent être cliquées. Elles montrent la position actuelle (ligne ou page, respectivement, ouvrent une boîte de dialogue pour indiquer une ligne ou une page à atteindre en cliquant. Les autres zones ouvrent des menus contextuels où on peut changer quelques paramètres. - - -\section{Créer un document} - -\subsection{Écrire le document} - -Comme exemple d'utilisation de \Tw, nous allons travailler avec \LaTeX\index{TeX@\TeX!\LaTeX}, mais tout autre système \TeX{} est possible. En particulier si vous avez besoin d'une police particulière\footnote{Vous ne pouvez utiliser que des fontes connues de \AllTeX, la plupart viennent dans des modules inclus dans votre distribution. Vous ne pouvez pas utiliser des fontes \og normales\fg, malheureusement. Pour plus d'information, voyez par exemple \url{http://faq.tug.org/} et \url{http://www.tug.dk/FontCatalogue/}.} -- imposée par un gabarit officiel, des alphabets non latins, etc. -- le système XeTeX est très puissant. \footnote{Voyez la bibliographie pour des pointeurs vers \XeTeX{} et \XeLaTeX.} - -Créons maintenant le premier document\index{document!création}! Entrez exactement le texte suivant (intentionnellement en français pour montrer quelques caractéristiques de \Tw/\LaTeX.) - -\begin{example} -\documentclass{article} - -\usepackage[utf8]{inputenc} -\usepackage[T1]{fontenc} -\usepackage{geometry} -\geometry{a4paper} - -\usepackage[francais]{babel} - -\title{Premier document} -\author{Un TeXnicien} -\date{} - -\begin{document} -\maketitle - -Voici un texte accentué en français! - -\end{document} -\end{example} - -Il faut enregistrer le document, en le mettant dans un dossier, que nous créons à cet effet pour les tests (ex.: \path{<home>\TeXworks_exemples}); le nom du document, par exemple \path{premier.tex}, doit avoir une extension \path{.tex}\index{extension .tex}. - -\subsection{Composer le document et le visionner} - -Ensuite lançons la composition\index{document!composition} \footnote{Nous utiliserons aussi les termes de compilation et compiler dans le même sens, en effet \LaTeX{} traite le fichier source pour produire le fichier de sortie \path{.pdf}, il y a donc compilation.} par un clic sur le bouton vert \raisebox{-2pt}{\includegraphics{iconTypeset}} ou par \keysequence{Ctrl+T}\index{Ctrl+T|texttt} (Mac OS X \keysequence{Cmd+T}). - -Un panneau s'ouvre entre la zone de saisie et la barre d'état, c'est le \emph{panneau de sortie\index{panneau de sortie}}, labellé \emph{Log\index{log}}; y apparaît tout ce que fait \LaTeX{} quand il travaille \footnote{Voyez page \pageref{fig:consoleOutput} pour une illustration de la base de la zone d'édition.}. Lorsque \LaTeX{} termine ce panneau disparaît (s'il n'y a pas d'erreur) et une nouvelle fenêtre apparaît à côté de la première; dans cette fenêtre, la \emph{Fenêtre de prévisualisation\index{fenêtre de prévisualisation}},\index{document!prévisualiser} on peut voir une page avec un titre \og Premier document\fg{} suivi d'un nom d'auteur \og Un TeXnicien\fg, tous les deux centrés, un texte \og Voici un texte accentué en français!\fg{} et en bas, au centre, un numéro de page. - -Remarquez que dans la vue le curseur de la souris représente une loupe! Si vous appuyez sur le bouton gauche de la souris vous pourrez voir le texte sous la loupe fortement agrandi (c'est une loupe non!); vous pouvez déplacer la loupe et ainsi inspecter le texte en détails. - -Pour retourner à la source, il suffit de cliquer dans la fenêtre de celui-ci ou mieux, vous verrez à l'usage, faire \keysequence{Ctrl+'} (Mac OS X \keysequence{Cmd+'}). Ce dernier raccourci est une bascule entre les deux fenêtres. Voyez aussi \ref{sec.synctex} pour vous déplacer automatiquement à un endroit sélectionné de la source vers la vue ou inversement. \footnote{Sous Windows on peut aussi utiliser \path{Alt+Tab} pour aller à la dernière fenêtre ouverte avant celle dans laquelle on est.} - -\subsection{Le travail de \LaTeX} - -Analysons maintenant brièvement le résultat pour comprendre ce qu'à fait \LaTeX{} et pourquoi. Des introductions et des tutoriels complets peuvent être trouvés sur Internet; voir par exemple \emph{flshort} \footnote{Une courte(?) introduction à \LaTeXe.} qui doit se trouver dans la distribution \LaTeX{} installée ou que l'on peut télécharger du net: faire une recherche sur CTAN\index{CTAN} \footnote{\emph{Comprehensive TeX Archives Network}, c'est un réseau de dépots miroir du CTAN central, on y trouve tout sur \TeX{}, \LaTeX{} et autres: \url{http://www.ctan.org}.}. -%% -%%\noindent\raisebox{5pt}{\rule{50mm}{1pt}} -%\vspace{5pt} - -Nous demandons d'abord de créer un document de la classe \emph{article}, il s'agit de la présentation globale du document. - -Ensuite nous signalons que le document d'entrée (la source) est sauvegardé au format Unicode \emph{utf-8\index{encodage!utf-8}\index{utf-8|see{encodage, utf-8}}} et qu'il contiendra donc des caractères qui n'existent pas dans l'ASCII standard sans accents. Nous désirons aussi utiliser un encodage de sortie T1 (l'encodage moderne de \TeX); nous voulons également un document en \emph{A4} et non le format par défaut \emph{US letter} américain. Enfin nous précisons que la typographie doit suivre les règles françaises en utilisant le module \textbf{\textsf{babel}} \footnote{ Cela influence, par exemple, la césure automatique des mots ou la façon dont les caractères de ponctuation sont composés.}. Ces instructions générales de travail se font par l'intermédiaire de modules\index{module} (package\index{package|see {module}}, en anglais) appelés avec des options. - -Finalement nous terminons la partie déclarative du document, le \emph{préambule}\index{préambule}, en précisant le titre, l'auteur et la date du document, ici nous spécifions sans la date. - -Puis vient le corps de texte, entre \verb+\begin{document}+ et \verb+\end{document}+ (ce sont des commandes \LaTeX). C'est ici que se trouvera tout ce qui doit apparaître dans le document. - -Réalisons quelques petites expériences pour montrer l'effet de ces instructions. Pour cela nous mettrons un \% devant les instructions; cela a pour effet de mettre le \% et tout ce qui le suit en commentaire\index{commentaire}, cette partie sera dès lors ignorée par \LaTeX \footnote{Remarquons que, par défaut (ce qui peut être modifié), les commentaires sont colorés en rouge par \Tw, ce qui les met en évidence.}. - -Commentez la ligne \verb|\usepackage[utf8]{inputenc}|, et composez le fichier. Vous devriez voir maintenant que les caractères accentués sont maintenant mal affichés dans la prévisualisation. Si de plus, vous commentez aussi la ligne \verb|\usepackage[frenchb]{babel}|, {\LaTeX} donnera une erreur. Tapez seulement \Return pour continuer la composition. -%Mettez successivement en commentaires les différentes lignes chargeant les modules (\verb+\usepackage[]{}+.) Lorsque vous mettrez en commentaire la demande du français, la composition s'arrêtera (pour \LaTeX{} il y a une erreur due au travail qui précède), tapez seulement \verb=[Enter]= pour continuer. Observez attentivement le résultat, par exemple avec la loupe la position du point d'exclamation par rapport au texte qui précède; voir aussi si tous les caractères sont présents, en particulier si vous commentez la ligne \verb|\usepackage[utf8]{inputenc}|. - -\needspace{3\baselineskip} -Après ces expériences, modifions le texte de la façon suivante: -\begin{example} -\begin{document} -\maketitle -\tableofcontents - -\section{Petite démonstration} - -Voici un texte accentué en français! -Suite du texte entré après avoir fait un retour chariot. Dans -l'éditeur on peut demander un passage à la ligne -du texte saisi; mais le numéro de ligne n'est incrémenté que par un -retour chariot. - -Nouvelle ligne en passant une ligne dans la source: c'est la manière -d'indiquer un changement de paragraphe. - -\end{document} -\end{example} -Refaites les expériences précédentes et observez les modifications qui apparaissent. - -Remarquez que le fait de n'entrer qu'un retour charriot ne crée pas un nouveau paragraphe. En \LaTeX, on doit insérer une ligne vide pour cela. Dans \Tw{} les lignes de la source (à droite de la barre de statut) numérote les lignes créées par un retour charriot, pas les lignes qui passent à la lignes automatiquement. - -\section{Et s'il y a des erreurs!}\index{erreurs} - -Lors de la création d'un document pour la composition \LaTeX, on ne peut manquer de faire des erreurs: oubli d'une accolade fermante ou d'une commande \verb+\end{}+ de fermeture d'un environnement, utilisation de commandes mathématiques sans commande de passage au mode mathématique,\dots{} Lors de la compilation, s'il y a une erreur, \LaTeX{} s'arrête, en vous permettant de traiter ce problème. Cet arrêt est visible par l'arrêt du défilement des actions dans le panneau de sortie, un message d'erreur y est affiché et \LaTeX{} attend une instruction pour savoir ce qu'il doit faire. - -\begin{center}\label{fig:consoleOutput} -\includegraphics[scale=.9]{consoleOutput}%[width=7cm]{tw-error} -%\setlength{\unitlength}{1mm}\begin{picture}(0,0) -%\put(-45,15){\colorbox{green}{\scriptsize Panneau de sortie}} -%\put(-35,3){\colorbox{green}{\scriptsize Console}} -%\put(-55,0.5){\colorbox{green}{\scriptsize Barre de statut}} -%\end{picture}\setlength{\unitlength}{1pt} -\end{center} - -On remarque le \emph{curseur de saisie\index{curseur de saisie}} dans une ligne entre le panneau de sortie et la barre de statut: la console de sortie ou barre console\index{barre console}\index{console de sortie}. - -Le message d'erreur est présenté sur plusieurs lignes, comme suit: -\smallskip - -\begin{verbExample} -! Undefined control sequence. -l.168 \dots fermante ou d'une commande \veb - +\end{}+ de fermeture d'un\dots -? -\end{verbExample} - -\LaTeX{} indique qu'il ne reconnaît pas un nom de commande (\texttt{Undefined control sequence}), suggère parfois de voir le manuel ou de taper \verb=h= (suivi de \Return) pour de l'aide, indique le numéro de ligne \footnote{Malheureusement, ce n'est pas toujours l'endroit de l'erreur dans la source. Ceci est discuté plus loin.} (ici 168) et l'endroit de l'erreur à la coupure de cette ligne (ici à \verb+\veb+). Enfin par le point d'interrogation indique qu'il attend une action de notre part. - -Il y a différentes actions possibles: -\begin{itemize} -\item taper \Return et demander de continuer comme si de rien n'était; parfois cela permet de terminer la compilation, mais il y aura une erreur dans le résultat; -\item taper \verb+h+\Return pour demander de l'aide; cette aide n'est pas toujours plus claire que le message d'erreur, mais souvent cela donne une indication; -\item taper \verb+i+\Return pour indiquer à \LaTeX{} que l'on va proposer un texte de remplacement, entrer celui-ci suivi de \Return, il sera utilisé pour la suite, avec reprise au niveau de l'erreur, mais il faudra faire la correction dans la source par après; \LaTeX{} ne fait a pas correction de la source au moment de la compilation; -\item taper \verb=x=\Return pour interrompre l'exécution de la compilation. C'est la façon traditionnelle de \AllTeX{} pour interrompre une compilation. - -Remarquons qu'on peut arrêter la compilation en répétant l'action de lancement: le bouton vert de compilation s'est changé en bouton rouge avec une croix blanche \raisebox{-2pt}{\includegraphics[scale=.8]{iconAbortTypesetting}}. En cliquant sur ce bouton ou encore par le raccourci \keysequence{Ctrl+T} (Mac OS X \keysequence{Cmd+T}) la compilation \LaTeX{} est arrêtée. Le panneau de sortie reste affiché et on peut donc encore y voir le message d'erreur. -\end{itemize} - -Il faut noter que parfois une erreur apparaît longtemps après sa position vraie. Par exemple ouvrir un environnement mais ne pas le refermer, \LaTeX{} ne s'en rend compte que lorsqu'il rencontre une autre fin d'environnement sans fermeture du premier. C'est souvent le \verb+\end{document}+ qui montre qu'un autre environnement n'a pas été fermé! - -Parfois, une erreur continue d'apparaître dans des compilations successives de \AllTeX{}, même après que le document aie été corrigé. Ceci peut survenir parce que \AllTeX{} crée un certain nombre de fichiers intermédiaires qui peuvent encore contenir le code original, fautif. Dès lors il est conseillé de supprimer ces fichiers après correction d'erreur. \Tw{} fournit une commande pour faciliter cela --- voir la section \ref{sec:remove-aux-files}. - -Après qu'une erreur a eu lieu, le panneau de sortie reste ouvert --- même après de compilations successives --- pour aider à la correction du problème (qui peut parfois demander plusieurs essais et redémarrage de \AllTeX. Une fois que tous les problèmes sont résolus, vous pouvez fermer le panneau de sortie par l'option de menu \menu{Fenêtre}\submenu\menu{Masquer la console de sortie}\index{console de sortie!masquer}. Par ailleurs, vous pouvez aussi configurer le panneau de sortie pour qu'il se ferme automatiquement dès que le processus de composition se termine avec succès en définissant \menu{Édition}\submenu\menu{Préférences\dots}\submenu\menu{Composition}\submenu\menu{Masquer la console de sortie:} à \emph{Après réussite}. Comme on peut facilement passer au dessus d'autres problèmes dans le document (par ex. des références non définies) cela empêche \AllTeX{} d'échouer, cette option n'est recommandée qu'aux utilisateurs expérimentés. - -Pour vous aider à trouver les erreurs (du moins si vous utilisez \LaTeX), \Tw{} est fourni avec un petit script qui extraie toutes les erreurs, mises en garde et autres messages intéressants de la console de sortie et vous les présente sous une sorme simple de tableau. - -\begin{center}\label{fig:errorParsingScript} -\includegraphics[scale=.9]{errorParsingScript} -\end{center} - -Dans ce cas, vous voyez une liste de messages de \LaTeX{}, avec les codes colorés et triés par sévérité. Le rouge montre les erreurs, le jaune les mises en garde et le bleu pour les boîtes sur- ou sous-remplies. À côté de la barre de couleur, vous voyez le nom du fichier où se trouve l'erreur. Ensuite, vous voyez le numéro de ligne (si le script a été capable de le déterminer), ainsi qu'un extrait de la console de sortie indiquant quelle était l'erreur. De plus le nom du fichier est un lien qui vous mènera au fichier (et si laligne a pu être déterminée, à la ligne) où \LaTeX{} a signalé l'erreur. En espérant que vous pourrez ainsi rapidement corriger les erreurs. - -Si vous n'utilisez pas \LaTeX, ce script pourra être de peu d'utilité, en particulier si la console de sortie est mise en forme de façon différente. Dans ce cas, vous pouvez simplement désactiver le script d'analyse des erreurs (voir la section \ref{sec:installing-scripts}). - - -\section{Paramétrer (un peu) \Tw{} pour notre convenance} -\index{TeXworks@\Tw!paramétrer} - -Si la police\index{editeur@éditeur!police} par défaut de l'éditeur ne nous convient pas, il est possible d'en changer par \menu{Format}\submenu\menu{Police\ldots} et choix dans la boîte de dialogue qui s'affiche. Ce changement sera cependant temporaire, on revient à la police par défaut si on ferme \Tw{} et qu'on l'ouvre à nouveau. - -À partir du menu \menu{Composition} ou par le menu déroulant de \menu{la barre d'outils Composition} on peut changer de format de compilation. De nouveau ce changement ne sera que provisoire. - -Pour obtenir un changement permanent, il faudra changer les \emph{préférences\index{préférences}} par le menu \menu{Édition}\submenu\menu{Préférences\ldots}, puis l'onglet \menu{Éditeur} pour la police et l'onglet \menu{Composition}, en bas, pour le format par défaut. - +% !TEX encoding = UTF8 +% !TEX root = manuel.tex +% !TEX spellcheck = fr_FR + +\chapter{Prise en main} +\label{chap:first-steps} + +Voyons maintenant comment réaliser un premier document: pour cela on devra le saisir dans la fenêtre d'édition de \Tw{}. \AllTeX{} \emph{n'étant pas} des logiciels WYSIWYG\index{WYSIWYG} \footnote{\emph{What You See Is What You Get}, c'est-à-dire \og ce que vous voyez est ce que vous obtenez\fg.}, vous devrez taper le texte et les instructions de mise en forme et vous ne verrez le résultat qu'après avoir \og composé\fg{} le texte. Cela paraît austère, mais on s'y fait très vite et on est amplement récompensé par le résultat. + +\section{Description sommaire de l'interface}\index{interface} + +\newsavebox{\inlineimg} +\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar1}\hspace{1em}} + +Lorsqu'il s'ouvre l'éditeur présente une interface très dépouillée: une barre de titre, une barre de menu, deux petites barres d'outils\index{barre d'outils}, une grande zone (blanche) de saisie et, tout en bas, une barre d'état. Nous sommes dans la fenêtre \emph{source/éditeur}\index{source/éditeur}. Si vous avez déjà composé le document auparavant, le \path{.pdf} résultant sera affiché du côté droit dans la fenêtre de \emph{prévisualisation.}\index{prévisualisation} +\vspace{10pt} + +%\noindent\includegraphics[scale=.6]{barreun}\hspace{10pt} +\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar1}\hspace{.5em}} +\begin{wrapfigure}[2]{l}{90pt} +\vspace*{-1em} +\usebox{\inlineimg} +\end{wrapfigure} +\noindent La première barre d'outils a un bouton pour lancer la composition et une liste déroulante pour choisir le format de composition (nous prendrons \verb|pdfLaTeX|.) Sachant que le raccourci clavier de la composition est \keysequence{Ctrl+T} (macOS: \keysequence{Cmd+T}) et que l'on ne change pratiquement jamais de format, on pourrait même ne pas afficher cette barre d'outils. De plus le choix peut se faire par le menu \menu{Composition}\index{composition}. +\vspace{10pt} + +%\noindent\includegraphics[scale=.6]{barredeux}\hspace{10pt} +\savebox{\inlineimg}{\includegraphics[scale=.6]{toolbar2}\hspace{.5em}} +%\begin{wrapfigure}[2]{l}{\widthof{\usebox{\inlineimg}}} +\begin{wrapfigure}[2]{l}{160pt} +\vspace*{-1em} +\usebox{\inlineimg} +\end{wrapfigure} +\noindent La deuxième n'offre que des boutons classiques: Nouveau document, Ouvrir, Sauvegarder | Annuler, Répéter | Couper, Copier, Coller | Rechercher, Remplacer. + +\begin{center} +\includegraphics[width=\textwidth]{interface-Tw} +%\setlength{\unitlength}{1mm}\begin{picture}(0,0) +%\put(-110,106.5){\colorbox{green}{\scriptsize Barre de titre}} +%\put(-100,103.5){\colorbox{green}{\scriptsize Menu}} +%\put(-92,101){\colorbox{green}{\scriptsize Barre d'outils}} +%\put(-118,56){\colorbox{green}{\small Zone d'édition}} +%\put(-42,56){\colorbox{green}{\small Prévisualisation}} +%\put(-115,1){\colorbox{green}{\scriptsize Barre de statut}} +%\end{picture}\setlength{\unitlength}{1pt} +\end{center} + +Même s'ils ne ressemblent pas à de vrais boutons, les zones de la barre de statut peuvent être cliquées. Elles montrent la position actuelle (ligne ou page, respectivement, ouvrent une boîte de dialogue pour indiquer une ligne ou une page à atteindre en cliquant. Les autres zones ouvrent des menus contextuels où on peut changer quelques paramètres. + + +\section{Créer un document} + +\subsection{Écrire le document} + +Comme exemple d'utilisation de \Tw, nous allons travailler avec \LaTeX\index{TeX@\TeX!\LaTeX}, mais tout autre système \TeX{} est possible. En particulier si vous avez besoin d'une police particulière\footnote{Vous ne pouvez utiliser que des fontes connues de \AllTeX, la plupart viennent dans des modules inclus dans votre distribution. Vous ne pouvez pas utiliser des fontes \og normales\fg, malheureusement. Pour plus d'information, voyez par exemple \url{http://faq.tug.org/} et \url{http://www.tug.dk/FontCatalogue/}.} -- imposée par un gabarit officiel, des alphabets non latins, etc. -- le système XeTeX est très puissant. \footnote{Voyez la bibliographie pour des pointeurs vers \XeTeX{} et \XeLaTeX.} + +Créons maintenant le premier document\index{document!création}! Entrez exactement le texte suivant (intentionnellement en français pour montrer quelques caractéristiques de \Tw/\LaTeX.) + +\begin{example} +\documentclass{article} + +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{geometry} +\geometry{a4paper} + +\usepackage[francais]{babel} + +\title{Premier document} +\author{Un TeXnicien} +\date{} + +\begin{document} +\maketitle + +Voici un texte accentué en français! + +\end{document} +\end{example} + +Il faut enregistrer le document, en le mettant dans un dossier, que nous créons à cet effet pour les tests (ex.: \path{<home>\TeXworks_exemples}); le nom du document, par exemple \path{premier.tex}, doit avoir une extension \path{.tex}\index{extension .tex}. + +\subsection{Composer le document et le visionner} + +Ensuite lançons la composition\index{document!composition} \footnote{Nous utiliserons aussi les termes de compilation et compiler dans le même sens, en effet \LaTeX{} traite le fichier source pour produire le fichier de sortie \path{.pdf}, il y a donc compilation.} par un clic sur le bouton vert \raisebox{-2pt}{\includegraphics{iconTypeset}} ou par \keysequence{Ctrl+T}\index{Ctrl+T|texttt} (macOS \keysequence{Cmd+T}). + +Un panneau s'ouvre entre la zone de saisie et la barre d'état, c'est le \emph{panneau de sortie\index{panneau de sortie}}, labellé \emph{Log\index{log}}; y apparaît tout ce que fait \LaTeX{} quand il travaille \footnote{Voyez page \pageref{fig:consoleOutput} pour une illustration de la base de la zone d'édition.}. Lorsque \LaTeX{} termine ce panneau disparaît (s'il n'y a pas d'erreur) et une nouvelle fenêtre apparaît à côté de la première; dans cette fenêtre, la \emph{Fenêtre de prévisualisation\index{fenêtre de prévisualisation}},\index{document!prévisualiser} on peut voir une page avec un titre \og Premier document\fg{} suivi d'un nom d'auteur \og Un TeXnicien\fg, tous les deux centrés, un texte \og Voici un texte accentué en français!\fg{} et en bas, au centre, un numéro de page. + +Remarquez que dans la vue le curseur de la souris représente une loupe! Si vous appuyez sur le bouton gauche de la souris vous pourrez voir le texte sous la loupe fortement agrandi (c'est une loupe non!); vous pouvez déplacer la loupe et ainsi inspecter le texte en détails. + +Pour retourner à la source, il suffit de cliquer dans la fenêtre de celui-ci ou mieux, vous verrez à l'usage, faire \keysequence{Ctrl+'} (macOS \keysequence{Cmd+'}). Ce dernier raccourci est une bascule entre les deux fenêtres. Voyez aussi \ref{sec.synctex} pour vous déplacer automatiquement à un endroit sélectionné de la source vers la vue ou inversement. \footnote{Sous Windows on peut aussi utiliser \path{Alt+Tab} pour aller à la dernière fenêtre ouverte avant celle dans laquelle on est.} + +\subsection{Le travail de \LaTeX} + +Analysons maintenant brièvement le résultat pour comprendre ce qu'à fait \LaTeX{} et pourquoi. Des introductions et des tutoriels complets peuvent être trouvés sur Internet; voir par exemple \emph{flshort} \footnote{Une courte(?) introduction à \LaTeXe.} qui doit se trouver dans la distribution \LaTeX{} installée ou que l'on peut télécharger du net: faire une recherche sur CTAN\index{CTAN} \footnote{\emph{Comprehensive TeX Archives Network}, c'est un réseau de dépots miroir du CTAN central, on y trouve tout sur \TeX{}, \LaTeX{} et autres: \url{http://www.ctan.org}.}. +%% +%%\noindent\raisebox{5pt}{\rule{50mm}{1pt}} +%\vspace{5pt} + +Nous demandons d'abord de créer un document de la classe \emph{article}, il s'agit de la présentation globale du document. + +Ensuite nous signalons que le document d'entrée (la source) est sauvegardé au format Unicode \emph{utf-8\index{encodage!utf-8}\index{utf-8|see{encodage, utf-8}}} et qu'il contiendra donc des caractères qui n'existent pas dans l'ASCII standard sans accents. Nous désirons aussi utiliser un encodage de sortie T1 (l'encodage moderne de \TeX); nous voulons également un document en \emph{A4} et non le format par défaut \emph{US letter} américain. Enfin nous précisons que la typographie doit suivre les règles françaises en utilisant le module \textbf{\textsf{babel}} \footnote{ Cela influence, par exemple, la césure automatique des mots ou la façon dont les caractères de ponctuation sont composés.}. Ces instructions générales de travail se font par l'intermédiaire de modules\index{module} (package\index{package|see {module}}, en anglais) appelés avec des options. + +Finalement nous terminons la partie déclarative du document, le \emph{préambule}\index{préambule}, en précisant le titre, l'auteur et la date du document, ici nous spécifions sans la date. + +Puis vient le corps de texte, entre \verb+\begin{document}+ et \verb+\end{document}+ (ce sont des commandes \LaTeX). C'est ici que se trouvera tout ce qui doit apparaître dans le document. + +Réalisons quelques petites expériences pour montrer l'effet de ces instructions. Pour cela nous mettrons un \% devant les instructions; cela a pour effet de mettre le \% et tout ce qui le suit en commentaire\index{commentaire}, cette partie sera dès lors ignorée par \LaTeX \footnote{Remarquons que, par défaut (ce qui peut être modifié), les commentaires sont colorés en rouge par \Tw, ce qui les met en évidence.}. + +Commentez la ligne \verb|\usepackage[utf8]{inputenc}|, et composez le fichier. Vous devriez voir maintenant que les caractères accentués sont maintenant mal affichés dans la prévisualisation. Si de plus, vous commentez aussi la ligne \verb|\usepackage[frenchb]{babel}|, {\LaTeX} donnera une erreur. Tapez seulement \Return pour continuer la composition. +%Mettez successivement en commentaires les différentes lignes chargeant les modules (\verb+\usepackage[]{}+.) Lorsque vous mettrez en commentaire la demande du français, la composition s'arrêtera (pour \LaTeX{} il y a une erreur due au travail qui précède), tapez seulement \verb=[Enter]= pour continuer. Observez attentivement le résultat, par exemple avec la loupe la position du point d'exclamation par rapport au texte qui précède; voir aussi si tous les caractères sont présents, en particulier si vous commentez la ligne \verb|\usepackage[utf8]{inputenc}|. + +\needspace{3\baselineskip} +Après ces expériences, modifions le texte de la façon suivante: +\begin{example} +\begin{document} +\maketitle +\tableofcontents + +\section{Petite démonstration} + +Voici un texte accentué en français! +Suite du texte entré après avoir fait un retour chariot. Dans +l'éditeur on peut demander un passage à la ligne +du texte saisi; mais le numéro de ligne n'est incrémenté que par un +retour chariot. + +Nouvelle ligne en passant une ligne dans la source: c'est la manière +d'indiquer un changement de paragraphe. + +\end{document} +\end{example} +Refaites les expériences précédentes et observez les modifications qui apparaissent. + +Remarquez que le fait de n'entrer qu'un retour charriot ne crée pas un nouveau paragraphe. En \LaTeX, on doit insérer une ligne vide pour cela. Dans \Tw{} les lignes de la source (à droite de la barre de statut) numérote les lignes créées par un retour charriot, pas les lignes qui passent à la lignes automatiquement. + +\section{Et s'il y a des erreurs!}\index{erreurs} + +Lors de la création d'un document pour la composition \LaTeX, on ne peut manquer de faire des erreurs: oubli d'une accolade fermante ou d'une commande \verb+\end{}+ de fermeture d'un environnement, utilisation de commandes mathématiques sans commande de passage au mode mathématique,\dots{} Lors de la compilation, s'il y a une erreur, \LaTeX{} s'arrête, en vous permettant de traiter ce problème. Cet arrêt est visible par l'arrêt du défilement des actions dans le panneau de sortie, un message d'erreur y est affiché et \LaTeX{} attend une instruction pour savoir ce qu'il doit faire. + +\begin{center}\label{fig:consoleOutput} +\includegraphics[scale=.9]{consoleOutput}%[width=7cm]{tw-error} +%\setlength{\unitlength}{1mm}\begin{picture}(0,0) +%\put(-45,15){\colorbox{green}{\scriptsize Panneau de sortie}} +%\put(-35,3){\colorbox{green}{\scriptsize Console}} +%\put(-55,0.5){\colorbox{green}{\scriptsize Barre de statut}} +%\end{picture}\setlength{\unitlength}{1pt} +\end{center} + +On remarque le \emph{curseur de saisie\index{curseur de saisie}} dans une ligne entre le panneau de sortie et la barre de statut: la console de sortie ou barre console\index{barre console}\index{console de sortie}. + +Le message d'erreur est présenté sur plusieurs lignes, comme suit: +\smallskip + +\begin{verbExample} +! Undefined control sequence. +l.168 \dots fermante ou d'une commande \veb + +\end{}+ de fermeture d'un\dots +? +\end{verbExample} + +\LaTeX{} indique qu'il ne reconnaît pas un nom de commande (\texttt{Undefined control sequence}), suggère parfois de voir le manuel ou de taper \verb=h= (suivi de \Return) pour de l'aide, indique le numéro de ligne \footnote{Malheureusement, ce n'est pas toujours l'endroit de l'erreur dans la source. Ceci est discuté plus loin.} (ici 168) et l'endroit de l'erreur à la coupure de cette ligne (ici à \verb+\veb+). Enfin par le point d'interrogation indique qu'il attend une action de notre part. + +Il y a différentes actions possibles: +\begin{itemize} +\item taper \Return et demander de continuer comme si de rien n'était; parfois cela permet de terminer la compilation, mais il y aura une erreur dans le résultat; +\item taper \verb+h+\Return pour demander de l'aide; cette aide n'est pas toujours plus claire que le message d'erreur, mais souvent cela donne une indication; +\item taper \verb+i+\Return pour indiquer à \LaTeX{} que l'on va proposer un texte de remplacement, entrer celui-ci suivi de \Return, il sera utilisé pour la suite, avec reprise au niveau de l'erreur, mais il faudra faire la correction dans la source par après; \LaTeX{} ne fait a pas correction de la source au moment de la compilation; +\item taper \verb=x=\Return pour interrompre l'exécution de la compilation. C'est la façon traditionnelle de \AllTeX{} pour interrompre une compilation. + +Remarquons qu'on peut arrêter la compilation en répétant l'action de lancement: le bouton vert de compilation s'est changé en bouton rouge avec une croix blanche \raisebox{-2pt}{\includegraphics[scale=.8]{iconAbortTypesetting}}. En cliquant sur ce bouton ou encore par le raccourci \keysequence{Ctrl+T} (macOS \keysequence{Cmd+T}) la compilation \LaTeX{} est arrêtée. Le panneau de sortie reste affiché et on peut donc encore y voir le message d'erreur. +\end{itemize} + +Il faut noter que parfois une erreur apparaît longtemps après sa position vraie. Par exemple ouvrir un environnement mais ne pas le refermer, \LaTeX{} ne s'en rend compte que lorsqu'il rencontre une autre fin d'environnement sans fermeture du premier. C'est souvent le \verb+\end{document}+ qui montre qu'un autre environnement n'a pas été fermé! + +Parfois, une erreur continue d'apparaître dans des compilations successives de \AllTeX{}, même après que le document aie été corrigé. Ceci peut survenir parce que \AllTeX{} crée un certain nombre de fichiers intermédiaires qui peuvent encore contenir le code original, fautif. Dès lors il est conseillé de supprimer ces fichiers après correction d'erreur. \Tw{} fournit une commande pour faciliter cela --- voir la section \ref{sec:remove-aux-files}. + +Après qu'une erreur a eu lieu, le panneau de sortie reste ouvert --- même après de compilations successives --- pour aider à la correction du problème (qui peut parfois demander plusieurs essais et redémarrage de \AllTeX. Une fois que tous les problèmes sont résolus, vous pouvez fermer le panneau de sortie par l'option de menu \menu{Fenêtre}\submenu\menu{Masquer la console de sortie}\index{console de sortie!masquer}. Par ailleurs, vous pouvez aussi configurer le panneau de sortie pour qu'il se ferme automatiquement dès que le processus de composition se termine avec succès en définissant \menu{Édition}\submenu\menu{Préférences\dots}\submenu\menu{Composition}\submenu\menu{Masquer la console de sortie:} à \emph{Après réussite}. Comme on peut facilement passer au dessus d'autres problèmes dans le document (par ex. des références non définies) cela empêche \AllTeX{} d'échouer, cette option n'est recommandée qu'aux utilisateurs expérimentés. + +Pour vous aider à trouver les erreurs (du moins si vous utilisez \LaTeX), \Tw{} est fourni avec un petit script qui extraie toutes les erreurs, mises en garde et autres messages intéressants de la console de sortie et vous les présente sous une sorme simple de tableau. + +\begin{center}\label{fig:errorParsingScript} +\includegraphics[scale=.9]{errorParsingScript} +\end{center} + +Dans ce cas, vous voyez une liste de messages de \LaTeX{}, avec les codes colorés et triés par sévérité. Le rouge montre les erreurs, le jaune les mises en garde et le bleu pour les boîtes sur- ou sous-remplies. À côté de la barre de couleur, vous voyez le nom du fichier où se trouve l'erreur. Ensuite, vous voyez le numéro de ligne (si le script a été capable de le déterminer), ainsi qu'un extrait de la console de sortie indiquant quelle était l'erreur. De plus le nom du fichier est un lien qui vous mènera au fichier (et si laligne a pu être déterminée, à la ligne) où \LaTeX{} a signalé l'erreur. En espérant que vous pourrez ainsi rapidement corriger les erreurs. + +Si vous n'utilisez pas \LaTeX, ce script pourra être de peu d'utilité, en particulier si la console de sortie est mise en forme de façon différente. Dans ce cas, vous pouvez simplement désactiver le script d'analyse des erreurs (voir la section \ref{sec:installing-scripts}). + + +\section{Paramétrer (un peu) \Tw{} pour notre convenance} +\index{TeXworks@\Tw!paramétrer} + +Si la police\index{editeur@éditeur!police} par défaut de l'éditeur ne nous convient pas, il est possible d'en changer par \menu{Format}\submenu\menu{Police\ldots} et choix dans la boîte de dialogue qui s'affiche. Ce changement sera cependant temporaire, on revient à la police par défaut si on ferme \Tw{} et qu'on l'ouvre à nouveau. + +À partir du menu \menu{Composition} ou par le menu déroulant de \menu{la barre d'outils Composition} on peut changer de format de compilation. De nouveau ce changement ne sera que provisoire. + +Pour obtenir un changement permanent, il faudra changer les \emph{préférences\index{préférences}} par le menu \menu{Édition}\submenu\menu{Préférences\ldots}, puis l'onglet \menu{Éditeur} pour la police et l'onglet \menu{Composition}, en bas, pour le format par défaut. + diff -Nru texworks-manual-20200329/src/fr/README.md texworks-manual-20210308/src/fr/README.md --- texworks-manual-20200329/src/fr/README.md 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/fr/README.md 2021-03-08 17:33:22.000000000 +0100 @@ -45,7 +45,7 @@ Disclaimer ================================================================================ -Copyright (C) 2010-2019 Alain Delmotte, Stefan Löffler, and contributors. +Copyright (C) 2010-2021 Alain Delmotte, Stefan Löffler, and contributors. Some rights reserved. Unless noted otherwise, the icons in the images/ folder are taken from the diff -Nru texworks-manual-20200329/src/git_version.txt texworks-manual-20210308/src/git_version.txt --- texworks-manual-20200329/src/git_version.txt 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/src/git_version.txt 2021-03-08 17:33:22.000000000 +0100 @@ -1,2 +1,2 @@ -18e0761 -2020-03-29 15:48:24 +0200 +7d24168 +2021-03-08 17:33:22 +0100 diff -Nru texworks-manual-20200329/travis-ci/defs.sh texworks-manual-20210308/travis-ci/defs.sh --- texworks-manual-20200329/travis-ci/defs.sh 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/defs.sh 1970-01-01 01:00:00.000000000 +0100 @@ -1,33 +0,0 @@ -#!/bin/sh - -print_headline() -{ - local MSG="$1" - printf '%b' "\033[34;1m${MSG}\033[0m\n" -} - -print_info() { - local MSG="$1" - printf '%b' "\033[36m${MSG}\033[0m\n" -} - -print_warning() { - local MSG="$1" - printf '%b' "\033[33;1m${MSG}\033[0m\n" -} - -print_error() { - local MSG="$1" - printf '%b' "\033[31;1m${MSG}\033[0m\n" -} - -echo_and_run() { - local CMD="$1" - echo "${CMD}" - eval "${CMD}" -} - -echo_var() { - # echo "$1 = ${!1}" does not work in dash (Ubuntu's default sh) - eval "echo \"$1 = \$$1\"" -} diff -Nru texworks-manual-20200329/travis-ci/launchpad/debian/compat texworks-manual-20210308/travis-ci/launchpad/debian/compat --- texworks-manual-20200329/travis-ci/launchpad/debian/compat 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/debian/compat 1970-01-01 01:00:00.000000000 +0100 @@ -1 +0,0 @@ -9 diff -Nru texworks-manual-20200329/travis-ci/launchpad/debian/control texworks-manual-20210308/travis-ci/launchpad/debian/control --- texworks-manual-20200329/travis-ci/launchpad/debian/control 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/debian/control 1970-01-01 01:00:00.000000000 +0100 @@ -1,28 +0,0 @@ -Source: texworks-help -Section: tex -Priority: optional -Maintainer: Stefan Löffler <st.loeffler@gmail.com> -Build-Depends: debhelper (>= 9), texlive-latex-base, texlive-latex-extra, texlive-luatex, tex4ht, texlive-fonts-recommended, lmodern, texlive-lang-french, ghostscript, imagemagick, netpbm, zip -Standards-Version: 3.9.2 -Homepage: https://github.com/TeXworks/manual -Vcs-Git: https://github.com/TeXworks/manual.git -Vcs-Browser: https://github.com/TeXworks/manual - -Package: texworks-help-en -Architecture: all -Recommends: texworks -Description: English help files for TeXworks, a simple interface for working - with TeX documents. - . - For further information, see https://github.com/TeXworks/manual/ or - http://tug.org/texworks/ - -Package: texworks-help-fr -Architecture: all -Recommends: texworks -Description: French help files for TeXworks, a simple interface for working - with TeX documents. - . - For further information, see https://github.com/TeXworks/manual/ or - http://tug.org/texworks/ - diff -Nru texworks-manual-20200329/travis-ci/launchpad/debian/copyright texworks-manual-20210308/travis-ci/launchpad/debian/copyright --- texworks-manual-20200329/travis-ci/launchpad/debian/copyright 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/debian/copyright 1970-01-01 01:00:00.000000000 +0100 @@ -1,22 +0,0 @@ -This package was debianized by <AUTHOR> on <DATE> - -It was downloaded from https://github.com/TeXworks/manual/ - -Upstream Authors: - - Alain Delmotte, Stefan Löffler, and others - -Copyright: - - Copyright (C) 2009 Alain Delmotte - -License: - - You are free to distribute this software under the terms of - the GNU General Public License version 2. - On Debian systems, the complete text of the GNU General Public - License v2 can be found in the file `/usr/share/common-licenses/GPL-2'. - -The Debian packaging is copyright 2020, Stefan Löffler <st.loeffler@gmail.com> and -is licensed under the GPLv2, see `/usr/share/common-licenses/GPL-2'. - diff -Nru texworks-manual-20200329/travis-ci/launchpad/debian/rules texworks-manual-20210308/travis-ci/launchpad/debian/rules --- texworks-manual-20200329/travis-ci/launchpad/debian/rules 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/debian/rules 1970-01-01 01:00:00.000000000 +0100 @@ -1,21 +0,0 @@ -#!/usr/bin/make -f - -export DH_VERBOSE=1 -export TEXMFCACHE=/tmp/texmf-var - -.PHONY : TeXdirs - -%: - dh $@ - -override_dh_auto_build-indep: TeXdirs - $(MAKE) - -override_dh_auto_install-indep: - $(MAKE) dist - -override_dh_auto_clean: - $(MAKE) dist-clean - -TeXdirs: - mkdir -p "$TEXMFCACHE" diff -Nru texworks-manual-20200329/travis-ci/launchpad/debian/source/format texworks-manual-20210308/travis-ci/launchpad/debian/source/format --- texworks-manual-20200329/travis-ci/launchpad/debian/source/format 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/debian/source/format 1970-01-01 01:00:00.000000000 +0100 @@ -1 +0,0 @@ -3.0 (quilt) diff -Nru texworks-manual-20200329/travis-ci/launchpad/debian/texworks-help-en.install texworks-manual-20210308/travis-ci/launchpad/debian/texworks-help-en.install --- texworks-manual-20200329/travis-ci/launchpad/debian/texworks-help-en.install 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/debian/texworks-help-en.install 1970-01-01 01:00:00.000000000 +0100 @@ -1 +0,0 @@ -html/TeXworks-manual/en/* /usr/share/doc/texworks-help/Manual/en diff -Nru texworks-manual-20200329/travis-ci/launchpad/debian/texworks-help-fr.install texworks-manual-20210308/travis-ci/launchpad/debian/texworks-help-fr.install --- texworks-manual-20200329/travis-ci/launchpad/debian/texworks-help-fr.install 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/debian/texworks-help-fr.install 1970-01-01 01:00:00.000000000 +0100 @@ -1 +0,0 @@ -html/TeXworks-manual/fr/* /usr/share/doc/texworks-help/Manual/fr diff -Nru texworks-manual-20200329/travis-ci/launchpad/dput.cf texworks-manual-20210308/travis-ci/launchpad/dput.cf --- texworks-manual-20200329/travis-ci/launchpad/dput.cf 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/dput.cf 1970-01-01 01:00:00.000000000 +0100 @@ -1,14 +0,0 @@ -[tw-latest] -fqdn = ppa.launchpad.net -method = sftp -incoming = ~texworks/ubuntu/ppa/ -login = st.loeffler -allow_unsigned_uploads = 0 - -[tw-stable] -fqdn = ppa.launchpad.net -method = sftp -incoming = ~texworks/ubuntu/stable/ -login = st.loeffler -allow_unsigned_uploads = 0 - diff -Nru texworks-manual-20200329/travis-ci/launchpad/.gitignore texworks-manual-20210308/travis-ci/launchpad/.gitignore --- texworks-manual-20200329/travis-ci/launchpad/.gitignore 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/.gitignore 1970-01-01 01:00:00.000000000 +0100 @@ -1,3 +0,0 @@ -id_rsa_texworks -key.asc -keys.tar Binary files /tmp/IL9Tq3fCZJ/texworks-manual-20200329/travis-ci/launchpad/keys.tar.enc and /tmp/ul6Pv8fpMo/texworks-manual-20210308/travis-ci/launchpad/keys.tar.enc differ diff -Nru texworks-manual-20200329/travis-ci/launchpad/package.sh texworks-manual-20210308/travis-ci/launchpad/package.sh --- texworks-manual-20200329/travis-ci/launchpad/package.sh 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/launchpad/package.sh 1970-01-01 01:00:00.000000000 +0100 @@ -1,119 +0,0 @@ -#!/bin/sh - -# Exit on errors -set -e - -. "${TRAVIS_BUILD_DIR}/travis-ci/defs.sh" - -print_headline "Packaging for Launchpad" - -GIT_HASH=$(git --git-dir=".git" show --no-patch --pretty="%h") -GIT_DATE=$(git --git-dir=".git" show --no-patch --pretty="%ci") -DATE_HASH=$(date -u +"%Y%m%d%H%M") -VERSION="0.1.1" -VERSION_NAME="${VERSION}-${DATE_HASH}-git_${GIT_HASH}" - - -DEBDATE=$(date -R) - -echo_var "GIT_HASH" -echo_var "GIT_DATE" -echo_var "VERSION_NAME" -echo_var "DEBDATE" -echo_var "DEB_MAINTAINER_NAME" -echo_var "DEB_MAINTAINER_EMAIL" -echo_var "LAUNCHPAD_DISTROS" - -if [ -z "${DEB_MAINTAINER_NAME}" -o -z "${DEB_MAINTAINER_EMAIL}" -o -z "${DEB_PASSPHRASE}" -o -z "${LAUNCHPAD_DISTROS}" ]; then - print_error "DEB_MAINTAINER_NAME and/or DEB_MAINTAINER_EMAIL and/or DEB_PASSPHRASE and/or LAUNCHPAD_DISTROS are not set" - exit 0 -fi - -print_info "Decrypt keys" -cd "${TRAVIS_BUILD_DIR}/travis-ci/launchpad/" -openssl aes-256-cbc -K $encrypted_e8757174037a_key -iv $encrypted_e8757174037a_iv -in keys.tar.enc -out keys.tar -d -tar xvf keys.tar -cd "${TRAVIS_BUILD_DIR}" - -print_info "Import signing key" -gpg --import "${TRAVIS_BUILD_DIR}/travis-ci/launchpad/key.asc" - - -print_info "Add ppa.launchpad.net to known hosts" -# Add ppa.launchpad.net to ssh's known hosts so we can upload to it using sftp -echo "ppa.launchpad.net ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0aKz5UTUndYgIGG7dQBV+HaeuEZJ2xPHo2DS2iSKvUL4xNMSAY4UguNW+pX56nAQmZKIZZ8MaEvSj6zMEDiq6HFfn5JcTlM80UwlnyKe8B8p7Nk06PPQLrnmQt5fh0HmEcZx+JU9TZsfCHPnX7MNz4ELfZE6cFsclClrKim3BHUIGq//t93DllB+h4O9LHjEUsQ1Sr63irDLSutkLJD6RXchjROXkNirlcNVHH/jwLWR5RcYilNX7S5bIkK8NlWPjsn/8Ua5O7I9/YoE97PpO6i73DTGLh5H9JN/SITwCKBkgSDWUt61uPK3Y11Gty7o2lWsBjhBUm2Y38CBsoGmBw==" >> ~/.ssh/known_hosts - -print_info "Creating ~/.ssh/config" -echo """Host ppa.launchpad.net -IdentityFile ${TRAVIS_BUILD_DIR}/travis-ci/launchpad/id_rsa_texworks -User st.loeffler -""" >> ~/.ssh/config - -for DISTRO in ${LAUNCHPAD_DISTROS}; do - print_info "Packging for ${DISTRO}" - echo -n " " - - ORIG_VERSION=$(echo "${VERSION_NAME}" | tr "_-" "~") - ORIGNAME="texworks-help_${ORIG_VERSION}" - DEB_VERSION="${ORIG_VERSION}-1${DISTRO}" - DEBNAME="texworks-help_${DEB_VERSION}" - DEBDIR="${DEBNAME}" - echo_var "DEB_VERSION" - - print_info " exporting sources to ${DEBDIR}" - mkdir -p "${DEBDIR}" - cd "${TRAVIS_BUILD_DIR}" && git archive --prefix="${ORIGNAME}/" --output="${ORIGNAME}.orig.tar.gz" HEAD - tar -x -C "${DEBDIR}" --strip-components=1 -f "${ORIGNAME}.orig.tar.gz" - - print_info " copying debian directory" - cp -r "${TRAVIS_BUILD_DIR}/travis-ci/launchpad/debian" "${DEBDIR}" - - if [ -f "${TRAVIS_BUILD_DIR}/travis-ci/launchpad/${DISTRO}.patch" ]; then - print_info " applying ${DISTRO}.patch" - patch -d "${DEBDIR}" -p0 < "${TRAVIS_BUILD_DIR}/travis-ci/launchpad/${DISTRO}.patch" - fi - - print_info " preparing copyright" - sed -i -e "s/<AUTHOR>/${DEB_MAINTAINER_NAME}/g" -e "s/<DATE>/${DEBDATE}/g" "${DEBDIR}/debian/copyright" - - print_info " preparing changelog" - echo "texworks-help (${DEB_VERSION}) ${DISTRO}; urgency=low\n" > "${DEBDIR}/debian/changelog" - if [ -z "${TRAVIS_TAG}" ]; then - git log --reverse --pretty=format:"%w(80,4,6)* %s" ${TRAVIS_COMMIT_RANGE} >> "${DEBDIR}/debian/changelog" - echo "" >> "${DEBDIR}/debian/changelog" # git log does not append a newline - else - NEWS=$(sed -n "/^Release ${VERSION}/,/^Release/p" ${TRAVIS_BUILD_DIR}/NEWS | sed -e '/^Release/d' -e 's/^\t/ /') - echo "$NEWS" >> "${DEBDIR}/debian/changelog" - fi - echo "\n -- ${DEB_MAINTAINER_NAME} <${DEB_MAINTAINER_EMAIL}> ${DEBDATE}" >> "${DEBDIR}/debian/changelog" - - print_info " building package" - cd "${DEBDIR}" - - echo -n "" > "/tmp/passphrase.txt" || print_error "Failed to create /tmp/passphrase.txt" - # Write the passphrase to the file several times; debuild (debsign) - # will try to sign (at least) the .dsc file and the .changes files, - # thus reading the passphrase from the pipe several times - # NB: --passphrase-file seems to be broken somehow - for i in $(seq 10); do - echo "${DEB_PASSPHRASE}" >> "/tmp/passphrase.txt" 2> /dev/null || print_error "Failed to write to /tmp/passphrase.txt" - done - debuild -k00582F84 -p"gpg --no-tty --batch --passphrase-fd 0" -S < /tmp/passphrase.txt && DEBUILD_RETVAL=$? || DEBUILD_RETVAL=$? - rm -f /tmp/passphrase.txt - - if [ $DEBUILD_RETVAL -ne 0 ]; then - print_warning " debuild failed with status code ${DEBUILD_RETVAL}" - continue - fi - cd .. - - DEBFILE="${DEBNAME}_source.changes" - if [ -z "${TRAVIS_TAG}" ]; then - PPA="tw-latest" - else - PPA="tw-stable" - fi - print_info " scheduling to upload ${DEBFILE} to ${PPA}" - - echo "dput --config \"${TRAVIS_BUILD_DIR}/travis-ci/launchpad/dput.cf\" \"${PPA}\" \"${TRAVIS_BUILD_DIR}/${DEBFILE}\"" >> "${TRAVIS_BUILD_DIR}/travis-ci/launchpad/dput-launchpad.sh" -done diff -Nru texworks-manual-20200329/travis-ci/package.sh texworks-manual-20210308/travis-ci/package.sh --- texworks-manual-20200329/travis-ci/package.sh 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/travis-ci/package.sh 1970-01-01 01:00:00.000000000 +0100 @@ -1,3 +0,0 @@ -#!/bin/sh - -${TRAVIS_BUILD_DIR}/travis-ci/launchpad/package.sh diff -Nru texworks-manual-20200329/.travis.yml texworks-manual-20210308/.travis.yml --- texworks-manual-20200329/.travis.yml 2020-03-29 15:48:24.000000000 +0200 +++ texworks-manual-20210308/.travis.yml 1970-01-01 01:00:00.000000000 +0100 @@ -1,46 +0,0 @@ -language: minimal - -addons: - apt: - packages: - - texlive-latex-base - - texlive-latex-extra - - texlive-luatex - - tex4ht - - texlive-fonts-recommended - - lmodern - - texlive-lang-french - - ghostscript - - imagemagick - - netpbm - - tidy - - ubuntu-dev-tools - - debhelper - - dput - - fakeroot - - python-paramiko - -script: - - make dist - -after_success: - - ${TRAVIS_BUILD_DIR}/travis-ci/package.sh - -deploy: - - provider: script - skip_cleanup: true - on: - all_branches: true - condition: -f ${TRAVIS_BUILD_DIR}/travis-ci/launchpad/dput-launchpad.sh - script: sh "${TRAVIS_BUILD_DIR}/travis-ci/launchpad/dput-launchpad.sh" - - provider: releases - skip_cleanup: true - file_glob: true - file: - - html/*.zip - - pdf/**/*.pdf - api_key: - secure: Xs88hAj8PxJgod3P04XqdAIPdaKMb5KmWHCU12Ecm2lbuL5Ro8FTWYrkZSDKb8+NfmEyImD9znVbM3zvlznlrDxE8jHItSVtUtHYMYxQtlvqw0D7PQK14n6pZoemFi4APwLlxijFigNdIjGBxYfHWzQ8lVn3Gnm0Gfd87vHo5cfObDrqg9Mao21ucDN/NHXLRwbPkVwL5xoyWVWz4RyhoAsPRMVaOh7DNerALIeL+rA5+7klsK4o1trusvAJnb8VaO5EBgEOSs4oTp4rFsX8vDCOPJmeLZpA9Scp6k1sxACwmZDyXQVcgk+r/I8j7ZAeOY55mMjNjPw7gfEq76PuqJPF6Gt5CZE7jeJF/egkUH7vRaGWLJmLR6DWP587y7k5GudFF3DC8iusvNjNNm+bfkPMc9CqKg1B1XjIBJxVSs2rEYt0eBcticVI4DTNiJLW3tjGet66apKmgFETnftMGs95oJCfFJlGoWRIJT7I/9bL/JO6coEQh254s1oyCUvE1UO+w/bRnxJfeEotKOchpL3rPR7/OYdm3dxX+dAPsV1WMlbnuqeW1OTammvAAyGjiBExn6lhCAMqzXsoHAoOopfUE6kQ839sp5xSpHki9LWgNURmVF5O+rWxGo7jiY9Li7SV027/rbJlDa09u327kzfEj0CjyANV/GcpND3UUUs= - on: - tags: true - all_branches: trueAttachment: signature.asc
Description: PGP signature
--- End Message ---
--- Begin Message ---
- To: Hilmar Preusse <hille42@web.de>, 991123-done@bugs.debian.org
- Cc: Debian-TeX-maint <debian-tex-maint@lists.debian.org>
- Subject: Re: Bug#991123: unblock: texworks-manual/20210308-2
- From: Graham Inggs <ginggs@debian.org>
- Date: Sat, 17 Jul 2021 12:26:48 +0200
- Message-id: <CAM8zJQvgq2E9Z_fNj4M1PCRcvMPQ9minOQ28f46xdehS47MOeQ@mail.gmail.com>
- In-reply-to: <[🔎] YO9SN7OXrW+dFIQ6@sid.showcase.amasol.de>
- References: <[🔎] YO9SN7OXrW+dFIQ6@sid.showcase.amasol.de>
Unblocked.
--- End Message ---