User Tools

Site Tools


geda:style_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision Both sides next revision
geda:style_guide [2012/02/20 15:14]
127.0.0.1 external edit
geda:style_guide [2012/02/24 15:47]
bpaddock Replaced seul.org with geda-project.org.
Line 21: Line 21:
 The following are meant to stimulate discussion on document style: The following are meant to stimulate discussion on document style:
   - Consider that the document will be exported for inclusion on the "gEDA Tools Suite CD-ROM"​ as XHTML and/or PDF. Examples:   - Consider that the document will be exported for inclusion on the "gEDA Tools Suite CD-ROM"​ as XHTML and/or PDF. Examples:
-    * [[http://geda.seul.org/​wiki/?​do=export_raw]] will generate the gEDA Project Wiki's start page as plain text. Simply use your browser to copy to a text file and include on the CD-ROM image. +    * [[http://www.geda-project.org/​wiki/?​do=export_raw]] will generate the gEDA Project Wiki's start page as plain text. Simply use your browser to copy to a text file and include on the CD-ROM image. 
-    * [[http://geda.seul.org/​wiki/?​do=export_xhtml]] will generate the gEDA Project Wiki's start page as valid XHTML. Simply use your browser to "Save Page As...",​ and name the file {filename}.html. Note that the URLs in this file are NOT relative to this file, but are as they would be found on the gEDA Project Wiki. +    * [[http://www.geda-project.org/​wiki/?​do=export_xhtml]] will generate the gEDA Project Wiki's start page as valid XHTML. Simply use your browser to "Save Page As...",​ and name the file {filename}.html. Note that the URLs in this file are NOT relative to this file, but are as they would be found on the gEDA Project Wiki. 
-    * [[http://geda.seul.org/​wiki/?​do=export_xhtmlbody]] will generate the gEDA Project Wiki's start page as valid rendered XHTML. Simply use your browser to "Save Page As...",​ and name the file {filename}.html. Note that the URLs in this file are NOT relative to this file, but are as they would be found on the gEDA Project Wiki. +    * [[http://www.geda-project.org/​wiki/?​do=export_xhtmlbody]] will generate the gEDA Project Wiki's start page as valid rendered XHTML. Simply use your browser to "Save Page As...",​ and name the file {filename}.html. Note that the URLs in this file are NOT relative to this file, but are as they would be found on the gEDA Project Wiki. 
-    * The following sequence of commands will retreive a gEDA Project Wiki page (for a list of the gEDA Project Wiki's pages, use the Index button at the bottom of the page) from the "​geda"​ namespace (when new wiki-pages are created, we __explicitly__ create them in the "​geda"​ namespace) and convert that page into a PDF document:\\ <​xterm>​% wget --convert-links -O {page-name}.wget %%"​http://​geda.seul.org/​wiki/​geda:​{page-name}?​do=export_html"​%%+    * The following sequence of commands will retreive a gEDA Project Wiki page (for a list of the gEDA Project Wiki's pages, use the Index button at the bottom of the page) from the "​geda"​ namespace (when new wiki-pages are created, we __explicitly__ create them in the "​geda"​ namespace) and convert that page into a PDF document:\\ <​xterm>​% wget --convert-links -O {page-name}.wget %%"​http://​www.geda-project.org/​wiki/​geda:​{page-name}?​do=export_html"​%%
 % sed -e '​s/​\&​amp;/​\&/​g'​ {page-name}.wget > {page-name}.sed % sed -e '​s/​\&​amp;/​\&/​g'​ {page-name}.wget > {page-name}.sed
 % iconv -f utf-8 -t iso-8859-1 {page-name}.sed > {page-name}.iconv % iconv -f utf-8 -t iso-8859-1 {page-name}.sed > {page-name}.iconv
Line 36: Line 36:
  
 For example, you would replace {page-name} above with the following for the related wiki-page: For example, you would replace {page-name} above with the following for the related wiki-page:
-  * start -- The wiki's main page, at [[http://​geda.seul.org/wiki/]]. +  * start -- The wiki's main page, at [[http://wiki.geda-project.org]]. 
-  * geda:​style_guide -- This wiki-page, at [[http://geda.seul.org/​wiki/​geda:​style_guide]]. +  * geda:​style_guide -- This wiki-page, at [[http://www.geda-project.org/​wiki/​geda:​style_guide]]. 
-  * geda:faq -- The wiki's FAQ page, at [[http://geda.seul.org/​wiki/​geda:​faq]]+  * geda:faq -- The wiki's FAQ page, at [[http://www.geda-project.org/​wiki/​geda:​faq]]
  
 A !!sample script!! to convert a single wiki-page into a PDF document.\\ A !!sample script!! to convert a single wiki-page into a PDF document.\\
geda/style_guide.txt · Last modified: 2012/10/25 08:57 by vzh