Under construction

From The Yambo Project
Jump to: navigation, search

Porting the old site to the wiki

An outline of the sections and new pages in the new site is given at: New main page.

Please keep the current Main Page clean and with only working links! When a section is complete, add it to the current Main Page.

Use this Sandbox for testing links, etc.

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 
writing
preformatted

''text''

and code snippets

Standards

Here are some ideas for standardizing things, but we can change these of course. Some ideas taken from fedoraproject.

For writing commands, use the $ dollar (+ space) prompt, indented by a space to form a code block:

$ yambo -I ../ -F yambo.in -o c

If showing command plus output, the prompt can be used to help distinguish command/output:

$ ls SAVE
ns.db1 ns.wf ndb.QP

Files and directories should be put in the italics environment: plot the o.eps.dat file and move it into SAVE

Code snippets, names of executables, commands, yambo options and inout variables should be put in the 'code' environment, eg. Use git to download source. Run the code withis yambo -I and use the -J option

Writing symbols, etc, inline:

Simple mathematical symbols can be put in italics (We next compute W, the screened exchange), and subscripts/superscripts are possible with Sub and sup tags
Greek letters can be inserted using a wiki editor or HTML characters.
More complicated symbols could be put in the 'math' environment, e.g. (This yields the quantity [math]|\psi|^2[/math]). However, this might not be rendered immediately, so avoid if possible.

Templates can be used to standardize repeated things. This can be useful for the input file documentation. Use the var3 template. See the Variables page for details.

Variable: FFTGvecs (Units: RL) Meaning: Number of G-vectors in FFT
Tip: This determines the number of G-vectors used in FFT calls and in the dipole matrix elements. Try reducing it to reduce the overall memory.

Variable: EXXRLvecs (Units: RL) Meaning: Number of G-vectors in exchange
Tip: Best to leave this equal to FFTGvecs

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 blocks, e.g.

<math> \Phi_i({\bf r}) = \sum_{\bf G}^{N_G} c_i({\bf G}) e^{i{\bf G}\cdot{\bf r}} </math> 

gives

[math]\Phi_i({\bf r}) = \sum_{\bf G}^{N_G} c_i({\bf G}) e^{i{\bf G}\cdot{\bf r}}[/math]

The only problem is that it needs some moments to render - if you see no formula here, perhaps the page needs reloading.

Images

Have a look at the guidelines. Probably if reusing old equation pngs one should use a form not rendered inline l by using a none or center label. Use 'x50px' to rescale formulae by height.

 [[File:Example.jpg|x50px|center|alt alternate text]] 

e.g.:

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

alt GW formula

The screening interaction is defined as...

Front page set up

This is just a link to the New main page

Page for testing CSS style: testcsshere