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
Previous revision
geda:style_guide [2012/02/24 17:02]
bpaddock [For both existing and new documents] Removed CD-ROM reference.
geda:style_guide [2012/10/25 08:57] (current)
vzh Replace code for old plugins by new; add FIXME for broken links
Line 1: Line 1:
 ====== Style Guide ====== ====== Style Guide ======
-!!This is definitely a work in progress.!!\\+<note warning>This is definitely a work in progress.</​note>​ 
 All documentation is eventually going to be made available as both HTML and PDF.\\ All documentation is eventually going to be made available as both HTML and PDF.\\
 The problem is to convert the gEDA wiki's Dokuwiki-pages (i.e., XHTML) into a format that can be converted into PDF.\\ The problem is to convert the gEDA wiki's Dokuwiki-pages (i.e., XHTML) into a format that can be converted into PDF.\\
Line 24: Line 25:
     * [[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://​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://​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.     * [[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://​www.geda-project.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:\\ <code>% 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 33: Line 34:
   --links --no-embedfonts --pagemode document --pagelayout single --firstpage p1 --pageeffect none \\   --links --no-embedfonts --pagemode document --pagelayout single --firstpage p1 --pageeffect none \\
   --pageduration 10 --effectduration 1.0 --no-encryption --permissions all --owner-password ""​   --pageduration 10 --effectduration 1.0 --no-encryption --permissions all --owner-password ""​
-  --user-password ""​ --browserwidth 680 -f {page-name}.pdf</​xterm> \\ where **''​{page-name}''​** is the wiki's page name as seen in the upper-left corner of the wiki.+  --user-password ""​ --browserwidth 680 -f {page-name}.pdf</​code> \\ where **''​{page-name}''​** is the wiki's page name as seen in the upper-left corner of the wiki.
  
 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:
Line 40: Line 41:
   * geda:faq -- The wiki's FAQ page, at [[http://​www.geda-project.org/​wiki/​geda:​faq]]   * geda:faq -- The wiki's FAQ page, at [[http://​www.geda-project.org/​wiki/​geda:​faq]]
  
-!!sample script!! to convert a single wiki-page into a PDF document.\\ +[[sample script]] [FIXME] ​to convert a single wiki-page into a PDF document.\\ 
-!!sample script!! to convert multiple wiki-pages into a single PDF document.+[[sample script]] [FIXME] ​to convert multiple wiki-pages into a single PDF document.
  
-An example of the current (as of 08 May 2006) version of the Wiki, [[http://​www.offramp.com/​wiki/​FC5_files/​Wiki.pdf|converted to PDF]].+An example of the current (as of 08 May 2006) version of the Wiki, [[http://​www.offramp.com/​wiki/​FC5_files/​Wiki.pdf|converted to PDF]][FIXME: broken link].
  
 ===== For new documents: ===== ===== For new documents: =====
Line 49: Line 50:
   - You must "​own"​ all content in the document. If you do not "​own"​ the content, you must get explicit permission from the "​owner"​ to copy the content to the gEDA Project Wiki (see below). Documents on the gEDA Project Wiki should be stand-alone,​ in the event the source document web-site disappears.   - You must "​own"​ all content in the document. If you do not "​own"​ the content, you must get explicit permission from the "​owner"​ to copy the content to the gEDA Project Wiki (see below). Documents on the gEDA Project Wiki should be stand-alone,​ in the event the source document web-site disappears.
   - **All** document contents are to be hosted on the gEDA Project Wiki. Images and other media files are to be uploaded to the wiki, and linked to. Do NOT link to external sites unless absolutely necessary.   - **All** document contents are to be hosted on the gEDA Project Wiki. Images and other media files are to be uploaded to the wiki, and linked to. Do NOT link to external sites unless absolutely necessary.
-  - All documents are to be maintained in the "​geda"​ [[http://wiki.splitbrain.org/wiki:namespaces|namespace]]. If your document would take advantage of a separate namespace, ask Ales if "​geda:​sub-namespace"​ is acceptable. This would be appropriate for very large documents with multiple chapters and lots of images. Such a namespace structure would allow the document to be "​broken"​ into chapters for easier navigation by the user (see [[http://​wiki.splitbrain.org/​wiki:​index|Index]] for more details).+  - All documents are to be maintained in the "​geda"​ [[https://www.dokuwiki.org/​namespaces|namespace]]. If your document would take advantage of a separate namespace, ask Ales if "​geda:​sub-namespace"​ is acceptable. This would be appropriate for very large documents with multiple chapters and lots of images. Such a namespace structure would allow the document to be "​broken"​ into chapters for easier navigation by the user (see [[http://​wiki.splitbrain.org/​wiki:​index|Index]] [FIXME: broken link] for more details).
  
 ===== For existing documents: ===== ===== For existing documents: =====
 The following are meant to stimulate discussion on document style: The following are meant to stimulate discussion on document style:
-  - +  - 
geda/style_guide.1330120952.txt.gz · Last modified: 2012/02/24 17:02 by bpaddock