← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/muse-el/oneiric

« back to all changes in this revision

Viewing changes to texi/muse.texi

  • Committer: Bazaar Package Importer
  • Author(s): Nicolai Spohrer
  • Date: 2008-06-14 15:53:54 UTC
  • mfrom: (1.1.5 upstream) (4.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080614155354-0oaitcwcadstwg1v
Tags: 3.12-1ubuntu1
https://launchpad.net/bugs/239998
* Merge with Debian unstable (LP: #239998), remaining changes:
  - Modified Maintainer field as per spec
  - Keep the GFDL manual:
    - Modified debian/rules to build the manual
    - Added copyright info about the manual in debian/copyright

Show diffs side-by-side

added added

removed removed

Lines of Context:
texi/muse.texi
12
12
@syncodeindex fn cp
13
13
 
14
14
@copying
15
 
This manual is for Emacs Muse version 3.11.
 
15
This manual is for Emacs Muse version 3.12.
16
16
 
17
 
Copyright @copyright{} 2004, 2005, 2006,
18
 
2007 Free Software Foundation, Inc.
 
17
Copyright @copyright{} 2004, 2005, 2006, 2007,
 
18
2008  Free Software Foundation, Inc.
19
19
 
20
20
@quotation
21
21
Permission is granted to copy, distribute and/or modify this document
136
136
* HTML::                        Publishing in HTML or XHTML form.
137
137
* Journal::                     Keeping a journal or blog.
138
138
* LaTeX::                       Publishing LaTeX documents.
139
 
* Poem::                        Publish a poem to LaTex or PDF.
 
139
* Poem::                        Publish a poem to LaTeX or PDF.
140
140
* Texinfo::                     Publish entries to Texinfo format or PDF.
141
141
* XML::                         Publish entries to XML.
142
142
 
401
401
@file{Makefile.defs} in the top-level directory, and then edit
402
402
@file{Makefile.defs} as follows.  You can put either a full path to an
403
403
Emacs or XEmacs binary or just the command name, as long as it is in the
404
 
@env{PATH}.  Depending on your setup, changes to the @option{PREFIX},
405
 
@option{ELISPDIR}, and/or @option{INFODIR} variables may also need to be
406
 
made.
 
404
@env{PATH}.
407
405
 
408
406
@example
409
407
EMACS    = xemacs
426
424
top-level directory, if you haven't done so already.  Then edit the
427
425
@file{Makefile.defs} file so that @env{ELISPDIR} points to where you
428
426
want the source and compiled Muse files to be installed and
429
 
@env{INFODIR} indicates where to put the Muse manual.  As mentioned
430
 
earlier, you will want to edit @env{EMACS} and @env{SITEFLAG} as shown
431
 
in the Compilation section if you are using XEmacs.
 
427
@env{INFODIR} indicates where to put the Muse manual.  You may use a
 
428
combination of @env{DESTDIR} and @env{PREFIX} to further determine where
 
429
the installed files should be placed.  As mentioned earlier, you will
 
430
want to edit @env{EMACS} and @env{SITEFLAG} as shown in the Compilation
 
431
section if you are using XEmacs.
432
432
 
433
433
If you are installing Muse on a Debian or Ubuntu system, you might want
434
434
to change the value of @env{INSTALLINFO} as specified in
928
928
@item M-x muse-colors-toggle-inline-images RET
929
929
Toggle display of inlined images on/off.
930
930
 
 
931
@item M-x muse-update-values RET
 
932
Update various values that are automatically generated.
 
933
 
 
934
Call this after changing @code{muse-project-alist}.
931
935
@end table
932
936
 
933
937
 
979
983
 
980
984
A line that begins with six or more columns of whitespace (either tabs
981
985
or spaces) indicates a centered paragraph.  Alternatively, you can use
982
 
the @verb{|<center>|} tag to surround regions that are to be published as
983
 
centered paragraphs.
 
986
the @verb{|<center>|} tag to surround regions that are to be published
 
987
as centered paragraphs.
984
988
 
985
989
@cindex paragraphs, quoted
986
990
@cindex quotations
1020
1024
particular style, rather than its derivations, by adding
1021
1025
@code{exact="t"} to the tag.
1022
1026
 
 
1027
@cindex line breaks
 
1028
@subheading Line breaks
 
1029
 
 
1030
If you need a line break, then use the @samp{<br>} tag.  Most of the
 
1031
time this tag is unnecessary, because Muse will automatically detect
 
1032
paragraphs by means of blank lines.  If you want to preserve newlines in
 
1033
several lines of text, then use verse markup instead (@pxref{Verse}).
 
1034
 
1023
1035
@node Headings, Directives, Paragraphs, Markup Rules
1024
1036
@comment  node-name,  next,  previous,  up
1025
1037
@section Levels of headings
1677
1689
 
1678
1690
@table @samp
1679
1691
 
 
1692
@item <br>
 
1693
Insert a line break.
 
1694
 
 
1695
Muse will automatically detect paragraphs when publishing by means of
 
1696
blank lines, so this tag is usually unnecessary.
 
1697
 
1680
1698
@item <cite>
1681
1699
Insert a citation to another source.
1682
1700
 
1873
1891
* HTML::                        Publishing in HTML or XHTML form.
1874
1892
* Journal::                     Keeping a journal or blog.
1875
1893
* LaTeX::                       Publishing LaTeX documents.
1876
 
* Poem::                        Publish a poem to LaTex or PDF.
 
1894
* Poem::                        Publish a poem to LaTeX or PDF.
1877
1895
* Texinfo::                     Publish entries to Texinfo format or PDF.
1878
1896
* XML::                         Publish entries to XML.
1879
1897
@end menu
2755
2773
 
2756
2774
This publishing style is capable of producing LaTeX or PDF documents.
2757
2775
 
2758
 
If you wish to publish PDF documents, you will need to have a good TeX
 
2776
If you wish to publish PDF documents, you will need to have a good LaTeX
2759
2777
installation.  For Debian and Ubuntu, this can be accomplished by
2760
2778
installing the ``tetex-bin'' and ``tetex-extra'' packages.  TeX fonts
2761
2779
are also a must.
2762
2780
 
 
2781
If your LaTeX installation has the file @file{grffile.sty}, which may be
 
2782
found in the @file{texlive-latex-recommended} package for Debian and
 
2783
Ubuntu, then consider using it by adding the following to your header
 
2784
file.  This allows spaces in filenames to work.
 
2785
 
 
2786
@example
 
2787
\usepackage@{grffile@}
 
2788
@end example
 
2789
 
2763
2790
@subheading Styles provided
2764
2791
 
2765
2792
@table @code
2937
2964
 
2938
2965
@node Poem, Texinfo, LaTeX, Publishing Styles
2939
2966
@comment  node-name,  next,  previous,  up
2940
 
@section Publish a poem to LaTex or PDF
 
2967
@section Publish a poem to LaTeX or PDF
2941
2968
 
2942
2969
The @code{muse-poem} module makes it easy to attractively publish and
2943
2970
reference poems in the following format, using the "memoir" module for
3354
3381
 
3355
3382
Prevent lines from being split before or after these characters.
3356
3383
 
 
3384
@item line-break
 
3385
@samp{<br>}
 
3386
 
 
3387
Break a line at point.
 
3388
 
3357
3389
@item fn-sep
3358
3390
@samp{Footnotes:}
3359
3391
 
3360
 
beginning of footnotes section
 
3392
Beginning of footnotes section.
3361
3393
 
3362
3394
@item footnote
3363
3395
@samp{[1]}