Интеграция ноутбуков в Центр документации Mathematica

чтобы показать, как создать документацию, которая включает в себя Центр документации, мы создадим пакет, который содержит очень простые функции и его документацию. Давайте назовем наш пакет SOPackage. Этот пакет будет храниться в папке с тем же именем, и такая папка должна храниться в любом $BaseDirectory или $UserBaseDirectory$. Элемент SOPakage папка должна иметь следующую древовидную структуру.

обратите внимание, что корневой каталог SOPackage.

SOPackage

теперь мы создадим новый файл Блокнота внутри SOPackage:SOPackage.nb. Таково содержание записной книжки

BeginPackage["SOPackage`"];
AddTwo::usage = "AddTwo[\!\(\*StyleBox[\"a\", \"TI\"]\), \!\(\*StyleBox[\"b\", \"TI\"]\)] returns \!\(\*StyleBox[\"a\", \"TI\"]\)+\!\(\*StyleBox[\"b\", \"TI\"]\).";
DotTwo::usage = "DotTwo[\!\(\*StyleBox[\"a\", \"TI\"]\), \!\(\*StyleBox[\"b\", \"TI\"]\)] returns \!\(\*StyleBox[\"a\", \"TI\"]\)*\!\(\*StyleBox[\"b\", \"TI\"]\).";
AddTwo::argnum = "AddTwo was called with `1` arguments. It expected 2.";
DotTwo::argnum = "DotTwo was called with `1` arguments. It expected 2.";
Begin["`Private`"];
AddTwo[a_, b_] := a + b
AddTwo[args___] := (Message[AddTwo::argnum, Length[{args}]]; $Failed)
DotTwo[a_, b_] := a*b
DotTwo[args___] := (Message[DotTwo::argnum, Length[{args}]]; $Failed)
End[];
EndPackage[];

вот скриншот того, что вы должны увидеть

обратите внимание, что сообщения об использовании обычно форматируют параметры особым образом. Ярлык, чтобы получить этот формат (указано @alexey-popkov), чтобы выделить письмо, которое вы хотите отформатировать, нажмите команда+0 ( Alt+0 в windows) и введите "TI". Повторите этот процесс для всех букв, которые необходимо изменить. Измените ячейку на ячейку инициализации через Cell->CellProperties->Initialization Cell. Теперь мы сохраняем этот блокнот как SOPackage.nb. На всякий случай Mathematica не спрашивал вас, Хотите ли вы создать пакет, потому что вы забыли изменить ячейку на ячейку инициализации, тогда вы можете перейти к Format->OptionInspector. Убедитесь, что вы выбираете "параметры для SOPackage.nb " в противном случае параметр, который вам нужно установить правда будет выделена серым цветом. Теперь нажмите на Notebook Options->FileOptions->AutoGeneratedPackage и выберите Automatic. Закройте окно Параметры и сохраните файл. Каждый раз, когда вы экономите SOPackage.nb файл SOPackage.m будет обновляться (не связывайтесь с этим файлом m).

The

Я загрузил ваш ApplicationMaker и тестирует его с помощью Mathematica 10 на Windows 7 64 бит. Отличная работа и хорошо документированы! Я обнаружил небольшую ошибку, которая нуждалась в исправлении на моей настройке при создании нового приложения с помощью NewApplication. Оказывается, что переменная root функции MakeDirectory не может быть строка с нулевой длиной (вызывает ошибку при создании каталогов). Я исправил это, включив тест в исходный код:

MakeDirectory[root_, start_, main_, sub_] := Module[
  {nm, ns, tmp},
  nm = Position[main, start];
  If[Length@nm != 0, nm = nm[[1, 1]]];
  If[Length@sub[[nm]] != 0,
   Do[
    tmp = 
     If[StringLength[root] != 0, 
      FileNameJoin[{root, start, sub[[nm, i]]}], 
      FileNameJoin[{start, sub[[nm, i]]}]];
    If[DirectoryQ[tmp], 
     Print[Style["Existing Directory : ", "MSG", Gray], 
      Style[tmp, "MSG", Bold]], 
     CreateDirectory[tmp];
     Print[Style["Directory Created  : ", "MSG", Blue], 
      Style[tmp, "MSG", Bold]]
     ];
    , {i, Length@sub[[nm]]}]
   ];
  Do[
   MakeDirectory[
    If[StringLength[root] != 0, FileNameJoin[{root, start}], start], 
    sub[[nm, i]], main, sub],
   {i, Length@sub[[nm]]}
   ]
  ]