User guide contributions

From Stellarium Wiki
(Difference between revisions)
Jump to: navigation, search
(Submitting a patch)
m (sp)
 
(10 intermediate revisions by 6 users not shown)
Line 9: Line 9:
 
==Getting LyX==
 
==Getting LyX==
  
You can get LyX from [http://www.lyx.org the LyX website].  You can use the latest stable release of LyX (1.4.3) to edit the .lyx files that make up the user guide.
+
You can get LyX from [http://www.lyx.org the LyX website].  You can use the latest stable release of LyX (1.5.1) to edit the .lyx files that make up the user guide.
 +
 
 +
Lyx is also available for Windows LyX-162-4-18-AltInstaller-Complete.exe . It is a slow process to install and as it is version 1.6.2 the files generated are not compatible with LyX 1.5.1. This is easily overcome by exporting them as LyX1.5x and changing the extension from lyx15 back to lyx. Further the windows basic version may not recognise *.svg graphics these can be loaded into TheGimp and saved as png files. Other than this it produces a pdf of from the current source.
  
 
==Submitting a patch==
 
==Submitting a patch==

Latest revision as of 13:29, 11 June 2010

Contributions to the guide would be great. Please, please make some!

For small corrections such as typos, spelling, grammar, and factual in-accuracies please email the author. For larger contributions - additional chapters, translations and so on, please consider using LyX to edit the document source and submit patches to the author.

[edit] Getting the document source

The source for the user guide is available by anonymous SVN from the sourceforge project pages.

[edit] Getting LyX

You can get LyX from the LyX website. You can use the latest stable release of LyX (1.5.1) to edit the .lyx files that make up the user guide.

Lyx is also available for Windows LyX-162-4-18-AltInstaller-Complete.exe . It is a slow process to install and as it is version 1.6.2 the files generated are not compatible with LyX 1.5.1. This is easily overcome by exporting them as LyX1.5x and changing the extension from lyx15 back to lyx. Further the windows basic version may not recognise *.svg graphics these can be loaded into TheGimp and saved as png files. Other than this it produces a pdf of from the current source.

[edit] Submitting a patch

Once you've got LyX and the guide source, edit the files and make a patch file using diff. You can find a nice tutorial about how to do this here.

Patches should be emailed to the guide author

Personal tools
Namespaces
Variants
Actions
in this wiki
other languages
Toolbox