Common Importing Problems: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
No edit summary
imported>Jeremy
Line 5: Line 5:


===Missing Pages===
===Missing Pages===
If one of the functions does not exist [[red hyperlink]]), you should create a new page for this function using the m-file help and [[Reference Manual Template]] for new reference manual entries.
If one of the functions does not exist ([[red hyperlink]]), you should create a new page for this function using the m-file help and [[Reference Manual Template]] for new reference manual entries.


===Missing Equations and/or Figures===
===Missing Equations and/or Figures===

Revision as of 12:39, 16 September 2008

Some of the things to watch out for:

Out of Date Options or Meta-Parameters

Some function pages will have out-of-date information on the options for the given function. You should look at the m-file help to verify all options are listed and all possible settings for those options are listed.

Missing Pages

If one of the functions does not exist (red hyperlink), you should create a new page for this function using the m-file help and Reference Manual Template for new reference manual entries.

Missing Equations and/or Figures

None of our images or equations will have been imported. Compare the page to the existing reference manual entry ("doc <functionname>" will open the HTML page). Images are all stored in the PLS_Toolbox/help folder.

Munged Options or Description lines

Some options and description text lines got converted into bulleted, bolded format (as if they were an option or input description):

  • In the case of an error, this function will return an empty array.
*'''In''' the case of an error, this function will return an empty array.

SOLUTION: remove * and ''' markup.

Broken-up Code Segments

Code segments which render like the following happen because the importer added blank lines between each code line:

peakdef = peakstruct(,3);
disp(peakdef(2))
peakdef(2) = peakstruct('PVoigt1');

SOLUTION: remove blank lines between code lines

Wrongly Formatted Example Segments

Example segments using : indenting instead of prefix of spaces or "pre" tags

     ===Examples===
     :peakdef = peakstruct('',3);
     :disp(peakdef(2))
     :peakdef(2) = peakstruct('PVoigt1');

SOLUTION: delete : and convert to <pre> tags

Function Assignments

See the function assignments page to determine which function(s) you are responsible for updating.