Common Importing Problems: Difference between revisions
imported>Jeremy No edit summary |
imported>Jeremy |
||
Line 12: | Line 12: | ||
===Broken-up Code Segments=== | ===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); | peakdef = peakstruct('',3); | ||
Line 19: | Line 21: | ||
'''SOLUTION''': remove blank lines between code lines | '''SOLUTION''': remove blank lines between code lines | ||
===Wrongly Formatted Example Segments=== | ===Wrongly Formatted Example Segments=== | ||
Example segments using : indenting instead of prefix of spaces or "pre" tags | Example segments using : indenting instead of prefix of spaces or "pre" tags |
Revision as of 12:26, 16 September 2008
Some of the things to watch out for:
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.