Vsdocman Help In
Total Page:16
File Type:pdf, Size:1020Kb
VSdocman Help © 2021 Helixoft VSdocman Help © 2021 Helixoft All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Printed: 03 2021 Contents 3 Table of Contents Part I Introduction 7 Part II Using VSdocman 7 1 How to.. .S..t.a..r.t.......................................................................................................................... 7 2 VSdo.c.m...a..n.. .W...i.n..d..o..w............................................................................................................... 12 3 Comp.i.l.i.n..g.. .D..o..c..u..m...e.n..t..a.t..io..n..................................................................................................... 15 4 Work.i.n..g.. .w..i.t.h.. .S..o..l.u..t.i.o..n..s........................................................................................................ 18 5 Addin.g.. .C...o..m..m...e..n..t.s................................................................................................................ 20 6 XML c..o..m..m...e..n..t.s..................................................................................................................... 23 7 Using. .C...u..s.t..o..m.. .T..o..p..i.c..s........................................................................................................... 25 8 Creat.in..g.. .a..n..d.. .U...s.i.n..g.. .C...o..n..t.e..x.t.. .S..e..n..s.i.t.i.v..e.. .H..e..l.p.......................................................................... 25 9 Using. .V..S...d..o..c.m...a..n.. .f.r.o..m... .C...o..m..m...a..n..d.. .l.i.n..e.................................................................................. 26 10 Addin.g.. .E..x..t.e..r.n..a..l. .F..i.l.e.s............................................................................................................ 28 11 Tips &.. .T..r..ic..k..s........................................................................................................................ 29 Using HT.M...L.. .a..n..d.. .U..n..k..n..o..w..n.. .T..a..g..s.. .i.n.. .X..M...L.. .C..o..m...m...e..n..t.s.. ....................................................................................... 29 Customiz.i.n..g.. .H...T..M..L.. .O...u..t.p..u..t. .............................................................................................................................. 31 Documen..t.i.n..g.. .A..t.t.a..c..h..e..d.. .P..r.o..p..e..r..t.i.e..s. .................................................................................................................. 36 Formattin..g.. .D..o..c..u..m...e..n..t.a..t.i.o..n.. .D..i.r..e..c.t.l.y.. .i.n.. .C..o..m...m...e..n..t.s.. .......................................................................................... 37 Adding N.e..w... .L..i.n..e.. .D..i.r..e..c.t.l.y.. .i.n.. .C..o..m...m...e..n..t.s.. ......................................................................................................... 39 Adding C.o..d..e.. .D...i.r.e..c..t.l.y. .i.n.. .C...o..m...m...e..n..t.s. ................................................................................................................ 39 Adding Im...a..g..e..s.. .i.n.. .D..o..c..u..m...e..n..t.a..t.i.o..n.. .................................................................................................................. 39 Adding C.l.a..s..s. .D...i.a..g..r.a..m...s. .i.n.. .D...o..c.u..m...e..n..t.a..t.i.o..n.. ...................................................................................................... 39 Creating .T..a..b..l.e..s.. .W...i.t.h.. .M...o..r.e.. .T..h..a..n.. .T..w...o.. .C..o..l.u..m...n..s.. ............................................................................................. 40 Using Ma.c..r.o..s.. .D..i.r.e..c..t.l.y.. .i.n.. .T..e..x..t. ......................................................................................................................... 41 Localizin.g.. .t.h..e.. .O...u..t.p..u..t. ..................................................................................................................................... 42 Hidden O.p..t.i.o..n..:. .G...e..n..e..r.a..t.e.. .L..i.n..k..s. .t.o.. .3..r.d.. .P...a..r.t.y.. .A..s.s..e..m...b..l.i.e..s. ................................................................................. 42 Hidden O..p..t.i.o..n..:. .A..l.l.o..w... .M..a..c..r.o..s.. .i.n.. .X..M...L.. .C..o..m...m...e..n..t.s.. ........................................................................................... 43 Hidden O..p..t.i.o..n..:. .D..o..n..'.t. .S..o..r.t. ."..S..e..e.. .A..l.s..o..". .L..i.n..k..s. .................................................................................................... 43 Hidden O..p..t.i.o..n..:. .D..i.s.p..l.a..y.. .s..h..o..r.t. .n..a..m...e..s. .o..f. .n..a..m...e..s..p..a..c..e..s. ...................................................................................... 43 Part III Project Properties 44 1 Profile..s................................................................................................................................. 48 2 Soluti.o..n..-.w...i.d..e.. .P..r.o..p..e..r.t..ie..s...................................................................................................... 53 3 Code .M...e..m..b..e..r..s. .O...p..t.i.o..n..s........................................................................................................ 55 Member .T..y.p..e..s.. ................................................................................................................................................ 55 Files .......................................................................................................................................................... 57 Regex Fi.l.t.e..r.s.. .................................................................................................................................................. 58 Condition..a..l. .C..o..m...p..i.l.a..t.i.o..n.. ................................................................................................................................. 61 4 Outpu..t. .O...p..t.i.o..n..s.................................................................................................................... 63 General .......................................................................................................................................................... 63 Documen..t.a..t.i.o..n.. .F..o..r.m...a..t. ................................................................................................................................... 65 © 2021 Helixoft 3 4 VSdocman Help Custom T..o..p..i.c.s.. ................................................................................................................................................ 66 Syntax &. .S..o..u..r..c.e.. .C...o..d..e.. ................................................................................................................................... 69 Platforms.. .&.. .F..r.a..m...e..w...o..r.k..s.. ................................................................................................................................ 70 Constant.s. .a..n..d.. .E..n..u..m...e..r.a..t.i.o..n..s.. .......................................................................................................................... 72 Page Set.u..p.. ..................................................................................................................................................... 74 File Nam.e..s.. ..................................................................................................................................................... 75 Context H..e..l.p.. ................................................................................................................................................... 76 5 Misce.l.l.a.n..o..u..s.. .O...p..t.i.o..n..s........................................................................................................... 78 Root Nam..e..s..p..a..c..e.. ............................................................................................................................................ 78 Custom V..a..r.i.a..b..l.e..s.. ........................................................................................................................................... 79 Part IV VSdocman Options 80 1 Comm..e..n..t.s.. .O..p..t..io..n..s............................................................................................................... 82 General .......................................................................................................................................................... 82 User Tag.s. .......................................................................................................................................................