Under construction: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
=== Porting the old site to the wiki ===
== Porting the old site to the wiki ==
== Converting from HTML to mediawiki ==
=== Converting from HTML to mediawiki ===
Here are a couple of online resources which I tested copying and pasting the source from the Yambo [http://www.yambo-code.org/download/index.php Download] page.
Here are a couple of online resources which I tested copying and pasting the source from the Yambo [http://www.yambo-code.org/download/index.php Download] page.


Line 7: Line 7:
* Using [http://pandoc.org/installing.html pandoc] installed locally, gave this: [[Download-pandoc-install]] which is pretty good. Command used was <pre>pandoc  index.html -f html -t mediawiki -o index.mw</pre>
* Using [http://pandoc.org/installing.html pandoc] installed locally, gave this: [[Download-pandoc-install]] which is pretty good. Command used was <pre>pandoc  index.html -f html -t mediawiki -o index.mw</pre>


There are other more powerful html-media wiki convertors but either they need php scripts run on the server or are difficult to set up, so I didn't have any success. In any case, we need to rewrite so much stuff there is little need for a 1-to-1 conversion.
There are other more powerful html-media wiki convertors (see e.g [https://www.mediawiki.org/wiki/Manual:Importing_external_content#Converting_content_from_HTML this]) but either they need php scripts run on the server or are difficult to set up, so I didn't have any success. In any case, we need to rewrite so much stuff there is little need for a 1-to-1 conversion.


== Converting/porting images ==
=== Converting/porting images ===
Without the powerful scripts mentioned above, there is no easy way to transfer all the image files across to the wiki. I managed at least to ease some of the work using the UploadWizard plugin. When you have created the new page, you  will now have links to missing image files. Either click on each one to upload one-at-a-time each image, OR click the "Upload File" link on the left menu of any page. Here you can select and upload many files at once. Unfortuntately it is not possible to automate everything in the wiki, so you need to click the date at least to accept the files. Don't change the file names. Afterwards, refresh the page/edit the page and you will see the images are now inserted. You will however have to resize them (see below).
Without the powerful converters mentioned above, there is no easy way to transfer all the image files across to the wiki. I managed at least to ease some of the work using the '''UploadWizard''' plugin.  


When you have created the new page, you  will now have links to missing image files. Either click on each one, or click the '''Upload File''' link on the left menu of any page.
* Click ''Back to the old form'' to upload one-at-a-time each image
* Otherwise continue with UploadWizeard to select and upload many files at once.
* Unfortunately it is not possible to automate everything in the wiki, so you need to click at least the date to accept the uploaded files.
* Don't change the file names, even if they seem a little different
* Afterwards, refresh the page/edit the page and you will see the images are now inserted.
* You will however have to resize them (see below).
* [https://www.mediawiki.org/wiki/Help:Formatting Markup]
== Formatting/fixing pages ==
=== Markup===
Pages will not convert perfectly, so some formatting into '''MediaWiki Markup Language''' is necessary. It is essential to read [https://www.mediawiki.org/wiki/Help:Formatting this Markup summary]. Take particular note of how to use
Different '''kinds''' and means
<nowiki>Of
preformatted
</nowiki>
<pre> text</pre>
and <code>code snippets</code>


=== Inserting simple math formulae ===
=== Inserting simple math formulae ===
Line 20: Line 43:
<math>\Phi_i({\bf r1}) = \sum_{\bf G}^{N_G} c_i({\bf G}) e^{i{\bf G}\cdot{\bf r}}</math>  
<math>\Phi_i({\bf r1}) = \sum_{\bf G}^{N_G} c_i({\bf G}) e^{i{\bf G}\cdot{\bf r}}</math>  


=== Uploading images ===
=== Images ===
A large
Have a look at the [https://www.mediawiki.org/wiki/Help:Images guidelines]. Probably if reusing old equation pngs one should use a form like:
 
<pre> [[File:Example.jpg|x20px|left|this is a caption]] </pre>
 
e.g.:
 
The GW approximation is obtained as first term in the expansion of Hedin equations in the expansion in the screened interaction '''W'''
[[File:newf.jpg|x20px|left|this is a caption]]
The screening interaction is defined as...


== Front page set up ==


This front page should look something like [https://www.mediawiki.org/wiki/MediaWiki this] - CH, or anyone who wants to hack the WM theme
This front page should look something like [https://www.mediawiki.org/wiki/MediaWiki this] - CH, or anyone who wants to hack the WM theme

Revision as of 21:30, 18 February 2017

Porting the old site to the wiki

Converting from HTML to mediawiki

Here are a couple of online resources which I tested copying and pasting the source from the Yambo Download page.

There are other more powerful html-media wiki convertors (see e.g this) but either they need php scripts run on the server or are difficult to set up, so I didn't have any success. In any case, we need to rewrite so much stuff there is little need for a 1-to-1 conversion.

Converting/porting images

Without the powerful converters mentioned above, there is no easy way to transfer all the image files across to the wiki. I managed at least to ease some of the work using the UploadWizard plugin.

When you have created the new page, you will now have links to missing image files. Either click on each one, or click the Upload File link on the left menu of any page.

  • Click Back to the old form to upload one-at-a-time each image
  • Otherwise continue with UploadWizeard to select and upload many files at once.
  • Unfortunately it is not possible to automate everything in the wiki, so you need to click at least the date to accept the uploaded files.
  • Don't change the file names, even if they seem a little different
  • Afterwards, refresh the page/edit the page and you will see the images are now inserted.
  • You will however have to resize them (see below).

Formatting/fixing pages

Markup

Pages will not convert perfectly, so some formatting into MediaWiki Markup Language is necessary. It is essential to read this Markup summary. Take particular note of how to use 

Different kinds and means

Of 
preformatted


 text

and code snippets

Inserting simple math formulae

After much trial and error I installed the SimpleMathJax plugin which works quite well, it's a cllent side rendering of LaTeX. Just insert your LaTeX within <math> ... </math> blocks. For instance: [math]\displaystyle{ \Phi_i({\bf r1}) = \sum_{\bf G}^{N_G} c_i({\bf G}) e^{i{\bf G}\cdot{\bf r}} }[/math]

Images

Have a look at the guidelines. Probably if reusing old equation pngs one should use a form like: 

 [[File:Example.jpg|x20px|left|this is a caption]]

e.g.:

The GW approximation is obtained as first term in the expansion of Hedin equations in the expansion in the screened interaction W

this is a caption

The screening interaction is defined as...

Front page set up

This front page should look something like this - CH, or anyone who wants to hack the WM theme

$f = 2$ --- Test SimpleMathJax: [math]\displaystyle{ \Phi_i({\bf r1}) = \sum_{\bf G}^{N_G} c_i({\bf G}) e^{i{\bf G}\cdot{\bf r}} }[/math] --- Template:Math ---


About

See Discussion

Learn

Might require reuse of math formulae

Get Started

Running Yambo

This, and input variables, is the most difficult part of the site to put together well. It will take some deeper planning

Support

Conor: my great hope is that the FAQ section will cut a lot of the posts to the forum, so structure it well...

News

Developers' Corner




Getting started

Retrieved from "https://wiki.yambo-code.eu/wiki/index.php?title=Under_construction&oldid=187"