Перейти к содержанию
    

Кто в чем делает документацию

кто-нибудь успешно использовал texinfo http://www.gnu.org/software/texinfo/ ?

У меня какие-то проблемы с кириллицей - выводит кракозябры...

Изменено пользователем ukpyr

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Я последнее время в LaTeX делаю документацию. Заточил стили под ЕСКД и норм.
Завершили и мы переезд под LaTeX. Все более чем удобно, качество выходного документа отличное. Но самое главное: забили в библиотеку компонентов новое поле 'Ref Name', изначально пустое. Теперь, допустим из документации нужно сослаться на микросхему DA14, которая является выходным RF усилителем. Если документация пишется после того как проект зафиксирован, то проблем нет - так и пишем 'DA14'. Но часто проект и дока развиваются одновременно, в этом случае при перенумерации элементов на схеме придется вносить изменения в текст. В LaTeX это решается просто и изящно: в отчетах системы проектирования генерируем файл вида:

\def \refRFAmp{DA14}
\def \refRFMixer{DA11}

где строка 'RFAmp' берется из вышеупомянутого поля 'Ref Name'. В LaTeX просто включаем этот файл и можно не думать о позиционном номере:

\include{prj-refnames}

% Пример ссылки на RefDes
Сигнал с выхода смесителя \refRFMixer{} после фильтрации поступает на выходной усилитель \refRFAmp{}, а затем...

 

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Help and manual скачал , а там всего 2 недели для пробы. Есть ли где сказать реально бесплатную версию?

Спасибо!

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

а вот от этих парней тулсы кто-нить пробовал?

по-моему "космический корабль" просто - умеет все...и pdf viewer мне их очень нравится заодно...

пользуюсь в основном для конвертинья чертежей из автокада

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Завершили и мы переезд под LaTeX. Все более чем удобно, качество выходного документа отличное. Но самое главное: забили в библиотеку компонентов новое поле 'Ref Name', изначально пустое. Теперь, допустим из документации нужно сослаться на микросхему DA14, которая является выходным RF усилителем. Если документация пишется после того как проект зафиксирован, то проблем нет - так и пишем 'DA14'. Но часто проект и дока развиваются одновременно, в этом случае при перенумерации элементов на схеме придется вносить изменения в текст. В LaTeX это решается просто и изящно: в отчетах системы проектирования генерируем файл вида:

\def \refRFAmp{DA14}
\def \refRFMixer{DA11}

где строка 'RFAmp' берется из вышеупомянутого поля 'Ref Name'. В LaTeX просто включаем этот файл и можно не думать о позиционном номере:

\include{prj-refnames}

% Пример ссылки на RefDes
Сигнал с выхода смесителя \refRFMixer{} после фильтрации поступает на выходной усилитель \refRFAmp{}, а затем...

 

Пробую внедрить Latex в своём бюро. Для простоты использую связку Latex-Lyx. Заморочек чуть больше но писать намного проще и быстрее чем в чистом Latex. Могу помочь с шаблонами и примерами.

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Написал для себя латеховский класс pcbdoc. С его помощью оформляю перечени элементов, спецификации, инструкции по настройке, схемы электрические принципиальные, сборочные чертежи, чертежи печатных плат и даже наклеечки для дисков. Очень доволен и с ужасом вспоминаю свои потуги делать все это во всяких компасах, вордах, и даже казалось бы специально заточенного для оформления чертежей менторовского Drawing Editor, тормознутого, кривого и падучего.

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Help and manual скачал , а там всего 2 недели для пробы. Есть ли где сказать реально бесплатную версию?

 

Бесплатную ищите на netz.ru или на сайтах, где есть серийники...

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Написал для себя латеховский класс pcbdoc. С его помощью оформляю перечени элементов, спецификации, инструкции по настройке, схемы электрические принципиальные, сборочные чертежи, чертежи печатных плат и даже наклеечки для дисков. Очень доволен и с ужасом вспоминаю свои потуги делать все это во всяких компасах, вордах, и даже казалось бы специально заточенного для оформления чертежей менторовского Drawing Editor, тормознутого, кривого и падучего.

можно посмотреть?

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

В смысле исходники выложить? Не вопрос, но чтобы кто-то смог ими воспользоваться, надо сначала документацию написать :(

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

В смысле исходники выложить? Не вопрос, но чтобы кто-то смог ими воспользоваться, надо сначала документацию написать :(
У нас есть для этого площадка. Вики для написания документации очень удобна...

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Вики для написания документации очень удобна...

Удобнее, чем latex? :)

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

В смысле исходники выложить? Не вопрос, но чтобы кто-то смог ими воспользоваться, надо сначала документацию написать :(

выкладывайте, посмотрим

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Удобнее, чем latex? :)

???

Посмотрите пакеты до их установки средствами LaTeX (например, Foiltex). Большинство из них САМОдокументированы!

Обычная поставка:

readme.somename (readme file)

somename.ins (driver file for unpacking the code)

somename.dtx (user guide and documented source)

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Удобнее, чем latex? :)
Смотря для каких целей. Если нужен совместный доступ к редактированию, то вики конечно удобней, а если нужно печатное качество, то конечно латех. В контексте написания инструкции к пакету, то, возможно, на вики лучше...

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Ок, выкладываю. Имейте ввиду, что

 

1. Класс заточен для xelatex. Входные файлы, следовательно, должны быть юникодные. Шрифт используется гостовский юникодный от аскона. К сожалению, не знаю, как заставить xelatex наклонять шрифт (подозреваю, что пока это невозможно, может быть, в будущих версиях появится такая возможность), поэтому в качестве наклонного используется с трудом найденный на просторах инета юникодный шрифт, но он кривой, что порождает проблемы - при просмотре полученного pdf в Acrobat не видно точек, впрочем, evince показывает нормально. Еще - нет кавычек в наклонном шрифте, приходится переключаться на прямой. Если не устраивает xelatex, затачивайте класс под latex самостоятельно, тут я не помощник.

2. Работаю в Debian 6. Все необходимые пакеты для работы с pcbdoc там есть. Класс успешно работал и в OpenSuse11.2. На других осях, в том числе и на ЕдинственноВерной, не проверял.

 

Скопируйте папку pcbdoc в ~/texmf/tex/latex, шрифты из fonts - в ~/.fonts, папку exаmple - куда нибудь. Зайдите куда-нибудь/example и запустите скрипт compile.sh.

pcbdoc.rar

fonts.rar

example.rar

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Присоединяйтесь к обсуждению

Вы можете написать сейчас и зарегистрироваться позже. Если у вас есть аккаунт, авторизуйтесь, чтобы опубликовать от имени своего аккаунта.

Гость
К сожалению, ваш контент содержит запрещённые слова. Пожалуйста, отредактируйте контент, чтобы удалить выделенные ниже слова.
Ответить в этой теме...

×   Вставлено с форматированием.   Вставить как обычный текст

  Разрешено использовать не более 75 эмодзи.

×   Ваша ссылка была автоматически встроена.   Отображать как обычную ссылку

×   Ваш предыдущий контент был восстановлен.   Очистить редактор

×   Вы не можете вставлять изображения напрямую. Загружайте или вставляйте изображения по ссылке.

×
×
  • Создать...