Skip to main content
Commonmark migration
Source Link

###Issue 1

Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

###Issue 2

Issue 2

Add Resources to "Documentation" Extensions of your Paclet, that will point to appropriate documentation notebook:

Paclet[ (*...,*) Extensions -> { {"Documentation", (*...,*) Resources -> { { "ReferencePages/Symbols/Unit\[Lambda]", "ReferencePages/Symbols/UnitLambda.nb" } } }, (*...*) } ] 

This method works in Mathematica version 9.0 and above (at time of writing tested up to version 11.0), but does not work in version 8 and earlier. If support for version 8 is needed, "hacky" solution, presented below, could be used.

###Issue 2 (Old hacky version)

Issue 2 (Old hacky version)

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with Mathematica versions 8.0.0, 9.0.1 and 10.0.0.

###Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

###Issue 2

Add Resources to "Documentation" Extensions of your Paclet, that will point to appropriate documentation notebook:

Paclet[ (*...,*) Extensions -> { {"Documentation", (*...,*) Resources -> { { "ReferencePages/Symbols/Unit\[Lambda]", "ReferencePages/Symbols/UnitLambda.nb" } } }, (*...*) } ] 

This method works in Mathematica version 9.0 and above (at time of writing tested up to version 11.0), but does not work in version 8 and earlier. If support for version 8 is needed, "hacky" solution, presented below, could be used.

###Issue 2 (Old hacky version)

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with Mathematica versions 8.0.0, 9.0.1 and 10.0.0.

Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

Issue 2

Add Resources to "Documentation" Extensions of your Paclet, that will point to appropriate documentation notebook:

Paclet[ (*...,*) Extensions -> { {"Documentation", (*...,*) Resources -> { { "ReferencePages/Symbols/Unit\[Lambda]", "ReferencePages/Symbols/UnitLambda.nb" } } }, (*...*) } ] 

This method works in Mathematica version 9.0 and above (at time of writing tested up to version 11.0), but does not work in version 8 and earlier. If support for version 8 is needed, "hacky" solution, presented below, could be used.

Issue 2 (Old hacky version)

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with Mathematica versions 8.0.0, 9.0.1 and 10.0.0.

Clarify that `Paclet` `Resources` solution doesn't work in MMA v8.
Source Link
jkuczm
  • 15.2k
  • 2
  • 55
  • 89

###Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

###Issue 2

Add "Resources"Resources to "Documentation" "Extensions"Extensions of your Paclet, that will point to appropriate documentation notebook:

Paclet[ (*...,*) Extensions -> { {"Documentation", (*...,*) "Resources"Resources -> { { "ReferencePages/Symbols/Unit\[Lambda]", "ReferencePages/Symbols/UnitLambda.nb" } } }, (*...*) } ] 

Tested on Linux with Mathematica versions fromThis method works in Mathematica version 9.0 and above (at time of writing tested up to version 11.0), but does not work in version 8 and earlier. If support for version 8 is needed, "hacky" solution, presented below, could be used.

###Issue 2 (Old hacky version)

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with MathematicaMathematica versions 8.0.0, 9.0.1 and 10.0.0.

###Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

###Issue 2

Add "Resources" to "Documentation" "Extensions" of your Paclet, that will point to appropriate documentation notebook:

Paclet[ (*...,*) Extensions -> { {"Documentation", (*...,*) "Resources" -> { { "ReferencePages/Symbols/Unit\[Lambda]", "ReferencePages/Symbols/UnitLambda.nb" } } }, (*...*) } ] 

Tested on Linux with Mathematica versions from 9.0 to 11.0.

###Issue 2 (Old hacky version)

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with Mathematica versions 8.0.0, 9.0.1 and 10.0.0.

###Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

###Issue 2

Add Resources to "Documentation" Extensions of your Paclet, that will point to appropriate documentation notebook:

Paclet[ (*...,*) Extensions -> { {"Documentation", (*...,*) Resources -> { { "ReferencePages/Symbols/Unit\[Lambda]", "ReferencePages/Symbols/UnitLambda.nb" } } }, (*...*) } ] 

This method works in Mathematica version 9.0 and above (at time of writing tested up to version 11.0), but does not work in version 8 and earlier. If support for version 8 is needed, "hacky" solution, presented below, could be used.

###Issue 2 (Old hacky version)

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with Mathematica versions 8.0.0, 9.0.1 and 10.0.0.

Add solution to issue 2 based on `Paclet` `"Resources"`.
Source Link
jkuczm
  • 15.2k
  • 2
  • 55
  • 89

###Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

###Issue 2

Add "Resources" to "Documentation" "Extensions" of your Paclet, that will point to appropriate documentation notebook:

Paclet[ (*...,*) Extensions -> { {"Documentation", (*...,*) "Resources" -> { { "ReferencePages/Symbols/Unit\[Lambda]", "ReferencePages/Symbols/UnitLambda.nb" } } }, (*...*) } ] 

Tested on Linux with Mathematica versions from 9.0 to 11.0.

###Issue 2 (Old hacky version)

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with Mathematica versions 8.0.0, 9.0.1 and 10.0.0.

###Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

###Issue 2

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with Mathematica versions 8.0.0, 9.0.1 and 10.0.0.

###Issue 1

If you want your documentation notebook to work, without problems, in different operating systems, you should avoid special characters in file names. I'd call your documentation notebook UnitLambda.nb

Last element of URI should match documentation notebook file name (without .nb). In specific case from question URI should be RapidSolver/ref/UnitLambda.

Make sure that all links in source documentation notebooks point to correct URI.

You can change URI cell from UnitLambda.nb and all links from other source notebooks using Eclipse search/replace functionality.

###Issue 2

Add "Resources" to "Documentation" "Extensions" of your Paclet, that will point to appropriate documentation notebook:

Paclet[ (*...,*) Extensions -> { {"Documentation", (*...,*) "Resources" -> { { "ReferencePages/Symbols/Unit\[Lambda]", "ReferencePages/Symbols/UnitLambda.nb" } } }, (*...*) } ] 

Tested on Linux with Mathematica versions from 9.0 to 11.0.

###Issue 2 (Old hacky version)

Add a small hack to your package:

Unprotect[Documentation`CreateMessageLink]; Documentation`CreateMessageLink["RapidSolver`", "Unit\[Lambda]", "usage", "English"] = Documentation`CreateMessageLink["RapidSolver`", "UnitLambda", "usage", "English"] Protect[Documentation`CreateMessageLink]; 

CreateMessageLink is a function used by Information to, as its name suggests, create a link at the and of a message. This hack will tell Mathematica that, when documentation page of RapidSolver`Unit\[Lambda] symbol is needed, it should really search for a page with URI ending with UnitLambda.

Your package will change definition of symbol from another package, which in general is a bad idea, but in this case redefinition affects only situations in which CreateMessageLink is called with context of your package as first argument, so it should be harmless.

You can put this code anywhere inside package file. Only relevant thing is that it gets executed when package is loaded.

Tested on Linux with Mathematica versions 8.0.0, 9.0.1 and 10.0.0.

Bounty Awarded with 100 reputation awarded by QuantumDot
Add tested environments. Small rewording.
Source Link
jkuczm
  • 15.2k
  • 2
  • 55
  • 89
Loading
Source Link
jkuczm
  • 15.2k
  • 2
  • 55
  • 89
Loading