|
Source Control Clients
Project Name: DocProject
Server URL: https://tfs01.codeplex.com
1-10 of 37Change Sets
< Previous 1 2 3 4 Next >
| 34004 |
|
Jun 16
at
5:09 AM
|
This changeset corresponds with the 1.11.0 Release Candidate.
- Fixed an issue whereby editing external XML documentation in source mode and then saving would write special doc tags into a namespace that is ignored by Sandcastle; for example, <see> links would not appear in the topics.
[http://www.codeplex.com/DocProject/WorkItem/View.aspx?WorkItemId=17049]
- Rebuilt the installer from the latest changeset and replaced it on the Releases page for 1.11.0 RC. |
davedev
|
156 |
| 33943 |
|
Jun 14
at
1:33 AM
|
This changeset corresponds with the 1.11.0 Release Candidate.
- Fixed an issue where the root Namespaces node wasn't being displayed in Topic Explorer when only one namespace was being documented.
- Rebuilt the installer from the latest changeset and replaced it on the Releases page for 1.11.0 RC, |
davedev
|
4 |
| 33935 |
|
Jun 13
at
3:43 PM
|
This changeset corresponds with the 1.11.0 Release Candidate. It contains a few bug fixes and some updates.
- DocProject.SED file removed from source control since it's automatically generated when the Installer project is built.
- Fixed bug in HtmlToXmlConverter that caused the XML documentation editor to move special comment end tags like </see> and </para> to the very end of the section.
- Hard-coded the version attribute in the DocProject.AddIn files for both versions of VS since it doesn't have to be generated during the installation.
- Fixed bug in the installer so that when installing for Everyone and both VS 2005 and 2008 simultaneously, the DocProject.AddIn files will have distinct names so that one doesn't overwrite the other. |
davedev
|
3 |
| 33856 |
|
Jun 9
at
3:38 AM
|
TFS failed to check-in multiple files, like normal. This changeset adds them - it corresponds to the 1.11.0 Release Candidate. |
davedev
|
25 |
| 33855 |
|
Jun 9
at
3:29 AM
|
This changeset corresponds with 1.11.0 Release Candidate.
Version Updates
- Installer = 1.11.0
- DaveSexton.DocProject = 1.11.0.0
- DaveSexton.DocProject.InstallPrep = 1.4.0.0
- DaveSexton.DocProject.DeploymentSandcastle = 1.3.1.0
- DaveSexton.DocProject.Sandcastle = 1.6.0.0
- DaveSexton.DocProject.ExternalUI = 1.2.0.0
- DaveSexton.DocProject.DocSites = 1.0.1.0
- DaveSexton.Controls.HtmlEditor = 2.0.0.0
- DaveSexton.Controls.XmlTreeView = 1.0.1.0
- DaveSexton.Sandcastle = 1.0.0.1
- DaveSexton.DocToMaml = 1.0
Notable Breaking Changes
- The DocProjectBuildPath environment variable has been deprecated, although it's still created by the installer in the release only - in the 1.12.0 Production release it won't be created. The DocProjectPath environment variable is now used in place of DocProjectBuildPath, but it points to the root installation folder. To reference the bin directory, for example, you must now use %DocProjectPath%\bin. DocProject's internal files and settings have been updated, including the new project templates.
- Keys in the versions.xml file that were generated using full source paths are no longer valid and should be removed from the file. For example, full paths are used for all project references; however, external sources that use relative paths are still valid.
- ReferenceInfo has been superseded by a new struct named, SystemPath. SystemPath is used in other places as well to constrain strings to valid local paths, which can specify a file or directory and have wildcards, including directory recursion.
- All paths are now saved relative to the project directory, but are fully qualified while being used by the application. Technically, this should not be a breaking change since the new SystemPath structure can handle absolute and relative paths as input, but it's mentioned here just in case it does affect older DocProjects and DocSite settings that might be imported into new projects. Manually making absolute paths relative should fix any problems.
- BuildEngine.ProjectItems property renamed to BuildItemsInternal and a new BuildItems property has been added to take the place of the UpdatedProjectItems property.
- Topic.Title property renamed to TocTitle (DaveSexton.DocProject.Sandcastle.TopicManagement namespace)
- SandcastleSettings.ConceptualTopicsDirectory property renamed to TopicsDirectory (likewise for the relative path equivalent).
- KeyedDocProjectItemCollection class renamed to DocProjectItemCollection.
- BuildSettings.Targets property was changed from string to IEnumerable<string>.
- The behavior for detecting out-of-date sources and files has changed. Timestamps are no longer cached. Instead, DocProject compares the current timestamps of input to the value of a new virtual property, BuildEngine.LastBuild, which, by default, gets the earliest "last write" DateTime of all of the files returned by the BuildSettings.Targets property. BuildEngine.SourceAssembliesDirty has also been replaced by a new virtual method named, HasChangedSince. Since the build state is now controlled by the outputs' last write times, an effect is that deleting the .chm or .HxS files no longer causes a partial build; it causes a full build instead. Another effect is that each time a project is opened in VS it doesn't neseccarily require a full build - it may even perform a partial build. Also, individual conceptual and HTML topics are monitored to detect whether changes have been made.
- DocProjectItemBase contract has changed. It now uses the new SystemPath class and does not provide functionality for storing timestamps. Also, relative paths are no longer supported (note: this has no negative effect when the same project is built on multiple systems with different root paths since built items are loaded dynamically - they are not persisted).
- The build engine now refreshes itself (i.e., checks file write times and reads the ProjectItems property) _after_ the project options are saved. This is required now that the Sandcastle build engine adds every file in the conceptual TOC to the project items collection, since the topics.xml file is opened directly and it may not be up-to-date until the project options are saved.
- BuildState.Preparing enum value no longer exists.
- A Source structure replaces the ExternalSource class. It is also used by IProjectOutput to encapsulate a project reference, which consists of an assembly and an optional XML documentation file.
- Generate root API topic is now enabled by default in new DocProjects and DocSites.
- Added "/ranu /rootsuffix Exp" to the devenv.exe command arguments on the Debug tab for the Add-In project so that the VS 2008 Experimental Hive will be used when debugging.
Bug fixes:
- When only building conceptual help, DocProject does not detect that topics have been added and will report that the help build was skipped because there are no project sources.
- The value of the DaveSexton.DocProject.Sandcastle.ReflectionApiElement.HasMethodOverloads property is not being set so it always returns false.
- Ineritance filter does not work correctly with local filtering enabled. Also, the UI does not display the correct default value for "include prefixes".
- The Topic Designer does not commit changes (at least not in exclusive source mode) when another item gets the focus.
- Topic Editor does not save external XML documentation for sections that were empty when a save operation occurred for the first time; i.e., subsequent saves do not persist elements that were previously empty.
- Topic Editor saves empty attributes; e.g., if seealso is added then both cref and href are always saved, even if only one is specified.
- VS crashes silently when a project is checked in and an attempt is made to delete a conceptual topic in Topic Explorer. (This is just one example of issues that can occur when working with source-controlled items.)
- Conceptual topic import feature does not use the same GUID when importing topics, which breaks existing conceptual links in topics that reference it. Also, it uses the full path as the TOC title when it should only be using the file name.
- ResolveExternalLinksComponent editor for the FileUrlMappingProvider class ignores all changes after losing input focus.
- Clicking the next button on a few of the New Project Wizard steps before the steps have actually initialized their edit control causes an exception.
- Filtering one or more conceptual topics without building reference (API) documentation causes an exception while compiling help.
- Build Component collection dialog will have corrupted state when a component is deleted from the list by pressing the Delete key (the Delete button works fine, however).
- Whitepaper template; fix spelling error: <downloadCenterLink> Optiona </downloadCenterLink>
- Imporoved all of the MAML topic templates.
- Cannot enter period character into External sources dialog.
- Cannot manually remove External source grid rows (without deleting the text and having the dialog delete empty rows automatically after clicking OK).
- Importing a file from the Topics folder into the same project crashes Visual Studio.
Features and Updates:
- Support for the Sandcastle May 2008 Release.
- A default snippets file is automatically included in new DocProjects and DocSites: Help\Settings\conceptual_snippets.xml. A reference to the file is added to ExampleComponent in the conceptual configuration files.
- A default tokens file is automatically included in new DocProjects and DocSites: Help\Settings\tokens.xml. A reference to the file is added to the tokens SharedContentComponent in all configuration files.
- A default external links file is automatically included in new DocProjects and DocSites: Help\Settings\links.xml. A reference to the file is added to the ResolveExternalLinksComponent in all configuration files.
- A default bibliography file is automatically included in new DocProjects and DocSites: Help\Settings\bibliography.xml. The Sandcastle Styles patch is required to support this feature. (http://www.codeplex.com/SandcastleStyles)
- A global Help 2.x metadata file is automatically included in new DocProjects and DocSites: Help\Settings\metadata.xml. A reference to the file is added to the ResolveExternalLinksComponent in all configuration files.
- New management dialogs for Help 1.x and Help 2.x project configuration. Various settings are persisted to files in Help\Settings\Projects\, Help\Topics\Html\MSHelp2\ and the root Help\ folder.
- All of the conceptual topic files found in the topics.xml file are added to the ProjectItems collection so that any modifications to the files will automatically cause a full build to occur. The same goes for raw HTML files found in the Help\Topics\Html\ folder, recursively. (Modifying the topics.xml file itself still causes a full build.)
- Automatic checkout of source-controlled project items (files and folders) to prevent issues where VS would crash silently due to file access errors. Automatic checkout occurs whenever a project option or dialog must write to a file in the project.
- Import Topics and Settings step added to the New Project Wizard. It allows you to browse for another project file, which is then loaded with MSBuild and exmained for its DocProject and Sandcastle version project options (defaults to 0.0.0.0) and Sandcastle presentation style information. When the New Project Wizard is finished, all topics, project options and settings are imported; although, some files may be taken from the Sandcastle installation if they are newer. When it's done a dialog that lists all messages accumilated during the operation is shown.
- Management dialog for external sources added to the last step of the New Project Wizard.
- New class: DaveSexton.DocProject.DocProjectFileGroup. Provides the ability to group multiple build item files together so that the base contract applies to all of them at once, while only a single item appears in the build items dialog.
- ResolveExternalLinksComponent now works for conceptual builds and is automatically added to the conceptual configuration files when a new DocProject or DocSite is created.
- XML that is appended to the configuration files when they are being imported is formatted nicely instead of being inserted as one long string.
- Added inheritdoc tag to the DocProject configuration file so that it appears in the Topic Editor sections list.
- Conceptual config files: The first SharedContentComponent is transformed so that a token file is found in the Help\Settings (This file is just a regular content item file that can be used with the <token></token> element.)
- Update project option descriptions (e.g., Topic Management).
- Update the example in conceptual_art.xml so that it includes a leading <para> and the outer <mediaLink> tag.
- Add an "open in VS" command to the DocProject External UI.
- New Topic Explorer context menu commands: "Properties", "Copy as reference link", "Copy as conceptual link" and "Copy a topic identifier".
- New Topic Properties window provides a UI for editing conceptual topic metadata, such as Help 2.x DocSet attributes, keywords and a display title.
- Topic import feature should check to make sure that the topic's root element is a topic tag with an id, and that the id is the same as the in-memory GUI | | | | | |